Update documentation
This commit is contained in:
parent
d21a6b4dba
commit
e36fcd2fb7
1 changed files with 9 additions and 1 deletions
10
docs/cli.md
10
docs/cli.md
|
@ -53,9 +53,9 @@ Options:
|
|||
-s, --subreddit <subreddit> The subreddit to search (default: "rabbits")
|
||||
-j, --json Output as JSON
|
||||
-q, --query-metadata Include query metadata in result
|
||||
-o <file> Output to file
|
||||
--sort <sort> Sort by (choices: "hot", "new", "top", default: "hot")
|
||||
-h, --help display help for command
|
||||
✨ Done in 0.32s.
|
||||
```
|
||||
|
||||
## JSON output
|
||||
|
@ -95,3 +95,11 @@ This defaults to "rabbits"
|
|||
$ randombunny --subreddit rabbits
|
||||
$ randombunny -s horses
|
||||
```
|
||||
|
||||
## Output to file
|
||||
|
||||
If you'd rather send the output to a file, you can supply the `-o` flag.
|
||||
|
||||
```
|
||||
$ randombunny -o ~/Desktop/output.txt
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue