Add documentation on the cli (#149)

# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

- Add documentation for the CLI

#117

## Type of change

Please delete options that are not relevant.

- [x] New feature (non-breaking change which adds functionality)
- [x] This change requires a documentation update

# How Has This Been Tested?

Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration.

# Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that provde my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/149
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>

docs/cli.md

@@ -0,0 +1,84 @@
+# CLI
+
+Since Version 2.2, Random Bunny contains a command line interface (CLI).
+
+## Default Output
+
+By default, the command will fetch a random image from `r/rabbits` and return it in a human-readable output.
+
+```
+$ randombunny
+
+Archived = false
+Downvotes = 0
+Hidden = false
+Permalink = /r/Rabbits/comments/1av1rg9/cute_baby_bun/
+Subreddit = Rabbits
+Subreddit Subscribers = 486084
+Title = Cute baby bun
+Upvotes = 211
+Url = https://i.redd.it/sfz0srdrimjc1.png
+```
+
+## Help
+
+The command also includes a help option in case you are stuck.
+
+```
+$ randombunny --help
+
+# or
+
+$ randombunny -h
+
+Usage: random-bunny [options]
+
+Get a random image url from a subreddit of your choosing
+
+Options:
+  -V, --version                output the version number
+  -s, --subreddit <subreddit>  The subreddit to search (default: "rabbits")
+  -j, --json                   Output as JSON
+  -q, --query-metadata         Include query metadata in result
+  --sort <sort>                Sort by (choices: "hot", "new", "top", default: "hot")
+  -h, --help                   display help for command
+✨  Done in 0.32s.
+```
+
+## JSON output
+
+You can also convert the output into JSON, if you need to input it to another program.
+
+```bash
+$ randombunny --json
+
+# or
+
+$ randonbunny -j
+
+{"Archived":false,"Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1av1rg9/cute_baby_bun/","Subreddit":"Rabbits","SubredditSubscribers":486085,"Title":"Cute baby bun","Ups":210,"Url":"https://i.redd.it/sfz0srdrimjc1.png"}
+```
+
+## Sort
+
+You can also choose the sorting option which reddit will use to return the available posts to randomise from.
+
+This defaults to "hot". The valid options are "hot", "new", and "top".
+
+```
+$ randombunny --sort hot
+$ randombunny --sort new
+$ randomBunny --sort top
+```
+
+
+## Subreddit
+
+You can change the subreddit which the command fetches from.
+
+This defaults to "rabbits"
+
+```
+$ randombunny --subreddit rabbits
+$ randombunny -s horses
+```

readme.md

@@ -44,6 +44,12 @@ The json string which gets returned consists of:
 
 `sortBy` will default to 'hot' if not given or invalid
 
+## CLI
+
+Random bunny can also be used as a CLI. This is accessible via the executable (see git releases) or via `src/cli.ts`
+
+For more details, see the documentation.
+
 ## Notes
 
 * Node 4 or newer.