From 87202669401e10cf78c68be66613f0edacb6bcff Mon Sep 17 00:00:00 2001
From: chee <chee@snake.dog>
Date: Sat, 23 Sep 2017 17:02:14 +0100
Subject: [PATCH] write about the command line flags in the README

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index dd22235..da63091 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,29 @@ jishon('犬', (error, response) => {
 })
 ```
 
+## there is a command line interface
+
+arguments:
+
+```sh
+# with none of these passed, it will return all three
+-w        return words
+-s        return sentences
+-n        return names
+
+-t 'tag'  filter words by tag
+```
+
+```sh
+# get the kanji for the first common word matching 'neko'
+$ jishon neko -wt 'common word' | jq -r '.[0].japanese'
+猫
+
+# get the full name of the first suziki returned
+$ jishon suzuki -n  | jq -r '.[0].meanings[0].english'
+Suzuki Emi (1985.9.13-)
+```
+
 ## screen photographs of action
 
 search in english: