yves-biener/sp
1
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

doc: usage with pipes

Browse Source
This commit is contained in:
Yves Biener
2023-10-08 12:20:20 +02:00
parent e8c8fe34db
commit 4555dc1ef8
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -16,4 +16,10 @@ Add the build `sp` executable in your `PATH` environment to easily invoke the to
## Usage
`sp <word>` to check the provided _word_. Returns the correct spelling of the word. In case of a misspelling the first suggestion of ispell is automatically choosen and returned.
`sp <word>` to check the provided _word_. Returns the correct spelling of the word. In case of a misspelling the first suggestion of ispell is automatically choosen and returned. The `<word>` may also be provided instead using pipes.
```bash
sp pple
# is equivalent to
echo pple | sp
```