Skip to content

Commit 45cd65c

Browse files
committed
fix: Update readme and some descriptions
1 parent 84db597 commit 45cd65c

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ go install github.com/gin-admin/gin-admin-cli/v10@latest
1313
### Create a new project
1414

1515
```bash
16-
gin-admin-cli new -d ~/go/src --name testapp --desc 'A test API service based on golang.' --module 'github.com/xxx/testapp'
16+
gin-admin-cli new -d ~/go/src --name testapp --desc 'A test API service based on golang.' --pkg 'github.com/xxx/testapp'
1717
```
1818

1919
### Generate a new module
@@ -67,7 +67,7 @@ Using `Dictionary` as an example, the configuration file is as follows `dictiona
6767
./gin-admin-cli gen -d ~/go/src/testapp -m SYS -c dictionary.yaml
6868
```
6969

70-
### Remove a module
70+
### Remove a struct from the module
7171

7272
```bash
7373
gin-admin-cli rm -d ~/go/src/testapp -m SYS -s Dictionary
@@ -87,9 +87,9 @@ OPTIONS:
8787
--name value The project name
8888
--desc value The project description
8989
--version value The project version (default: 1.0.0)
90-
--module value The project module name (default: project name)
90+
--pkg value The project package name (default: project name)
9191
--git-url value Use git repository to initialize the project (default: https://github.com/LyricTian/gin-admin.git)
92-
--git-branch value Use git branch to initialize the project
92+
--git-branch value Use git branch to initialize the project (default: master)
9393
--help, -h show help
9494
```
9595

cmd/generate.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ func Generate() *cli.Command {
1919
&cli.StringFlag{
2020
Name: "dir",
2121
Aliases: []string{"d"},
22-
Usage: "The directory to generate the struct from",
22+
Usage: "The project directory to generate the struct",
2323
Required: true,
2424
},
2525
&cli.StringFlag{

cmd/new.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func New() *cli.Command {
4646
},
4747
&cli.StringFlag{
4848
Name: "git-branch",
49-
Usage: "Use git branch to initialize the project",
49+
Usage: "Use git branch to initialize the project (default: master)",
5050
Required: false,
5151
},
5252
},

0 commit comments

Comments
 (0)