Skip to content

Commit 97e8762

Browse files
committed
doc: update usage
Signed-off-by: Abirdcfly <[email protected]>
1 parent 5a64b19 commit 97e8762

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ go install github.com/Abirdcfly/dupword/cmd/dupword@main
5959

6060
### 1. default
6161

62-
Run with default settings(include test file, only check keywords `the`,`a` and `and`):
62+
Run with default settings(include test file):
63+
**But note that not all repeated words are wrong**
6364

6465
```bash
6566
$ dupword ./...
@@ -110,7 +111,7 @@ Flags:
110111
-json
111112
emit JSON output
112113
-keyword value
113-
key words for detecting duplicate words (default the,and,a)
114+
key words for detecting duplicate words
114115
-memprofile string
115116
write memory profile to this file
116117
-source
@@ -124,6 +125,14 @@ Flags:
124125
-v no effect (deprecated)
125126
```
126127
128+
### 5. my advice
129+
130+
use `--keyword=the,and,a` and `-fix` together.
131+
132+
```bash
133+
$ dupword --keyword=the,and,a -fix ./...
134+
```
135+
127136
## TODO
128137
129138
- [ ] add this linter to golangci-lint

0 commit comments

Comments
 (0)