Skip to content

Commit

Permalink
write about the command line flags in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
chee committed Sep 23, 2017
1 parent 3760f59 commit 8720266
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Expand Up @@ -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:
Expand Down

0 comments on commit 8720266

Please sign in to comment.