From 4555dc1ef813239a9c9b9c0f0c7fa9b84b29a243 Mon Sep 17 00:00:00 2001 From: Yves Biener Date: Sun, 8 Oct 2023 12:20:20 +0200 Subject: [PATCH] doc: usage with pipes --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97b5ef4..a85eeff 100644 --- a/README.md +++ b/README.md @@ -16,4 +16,10 @@ Add the build `sp` executable in your `PATH` environment to easily invoke the to ## Usage -`sp ` 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. \ No newline at end of file +`sp ` 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 `` may also be provided instead using pipes. + +```bash +sp pple +# is equivalent to +echo pple | sp +```