Update readme with configuration reference and other section stubs

This commit is contained in:
FoxxMD
2021-06-02 20:39:38 -04:00
parent 0943fc4e80
commit 2363445848

View File

@@ -29,6 +29,8 @@ Some feature highlights:
* [How It Works](#how-it-works)
* [Installation](#installation)
* [Configuration](#configuration)
* [Usage](#usage)
### How It Works
@@ -70,3 +72,30 @@ npm install
```
foxxmd/reddit-context-bot:latest
```
## Configuration
Context Bot's configuration conforms to [JSON Schema](https://json-schema.org/) Draft 7 so you can view all documentation while also interactively writing and validating your config!
Any number of json validators exists but I suggest using [Atlassian JSON Schema Viewer](https://json-schema.app/start):
* Copy the url from the Raw button on [schema.json](/src/Schema/schema.json)
* Paste into the text box on the viewer page and hit **Load Schema**
From there you can drill down into any object, see its requirements, view an example JSON document, and live-edit your configuration on the right-hand side.
### Environmental Variables
Documentation coming soon
### Example Config
Coming soon
## Usage
Documentation coming soon
## License
[MIT](/LICENSE)