Skip to content

Commit 7bb6732

Browse files
committed
docs (readme): add new text option to documentation
1 parent a10c4ef commit 7bb6732

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,10 @@ By default `peck` will check for a `peck.json` file in your project root. If one
123123

124124
The path to check can be overwritten with the `--path` option. If the path is one you always need checking you can place it in your `peck.json` file.
125125

126+
#### `--text`
127+
128+
The `--text` option allows you to check a string of text for spelling mistakes. This is useful when you want to check a specific string, such as commit messages.
129+
126130
#### `--ignore-all`
127131

128132
This option will ignore all spelling mistakes in the current run. This is useful when you have a large number of mistakes and want to ignore them all at once.

0 commit comments

Comments
 (0)