Skip to content

Commit

Permalink
doc: tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
Bin-Huang committed Aug 5, 2022
1 parent 900ec80 commit d4eb1c1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,18 +101,18 @@ Some suggestions:

## Features & Motivation

**It makes your code easier to write and maintain**.
**1. It makes your code easier to write and maintain**.

Writing and updating constructor code for many structs can be laborious and error-prone, especially if you have a huge codebase. These should be handed over to automatic tools like this tool.

And it also works well with these dependency injection tools like [`wire`](https://github.com/google/wire). That is to say, if you use `wire` in your project, you may need this tool very much.


**It takes care of the generated code**.
**2. It takes care of the generated code**.

Don't worry about the imports, variable naming, and code style in the generated code.

**It doesn't need manual installation and another dependency**.
**3. It doesn't need manual installation and another dependency**.

It works anywhere there is a GO runtime and network. It doesn't break the work of other people who don't have installed this tool in collaboration.

Expand Down
6 changes: 3 additions & 3 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,17 +104,17 @@ func NewController(logger *zap.Logger, debug bool) *Controller {

## 功能特性与设计理念

**它能让你的代码更容易编写和维护**.
**1. 它能让你的代码更容易编写和维护**.

不管是编写还是更新构造器代码,都是一个费力且容易出错的事情,尤其当代码量很大的时候。这些繁琐易错的工作应该交给自动程序来完成,比如这个工具。

同时,这个工具还能完美兼容像[**wire**](https://github.com/google/wire)这种依赖注入工具。如果你的项目中也使用了 **wire**,那你可能非常需要这个工具。**wire****make-constructor** 的“加持”下会变得更加好用。

**你不需要担心自动生成的代码**.
**2. 你不需要担心自动生成的代码**.

这个工具在生成代码时会非常小心,会帮你考虑所有代码细节,包括引用依赖、变量命名,甚至还有代码风格。

**它不需要手动安装,也不需要引用其他依赖**.
**3. 它不需要手动安装,也不需要引用其他依赖**.

只要有 GO 环境和网络的地方,这个工具就能正常工作。你在项目中使用这个工具不会影响到其他同事,就算他们没有安装这个工具,代码的自动生成也不会有任何问题。

Expand Down

0 comments on commit d4eb1c1

Please sign in to comment.