mirror of
https://github.com/FoxxMD/context-mod.git
synced 2026-04-19 03:00:07 -04:00
Update readme with configuration reference and other section stubs
This commit is contained in:
29
README.md
29
README.md
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user