eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-16 18:50:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
baby-princess 2019-05-08 20:41:12 +00:00 • committed by GitHub
parent 1a35da6d7c
commit 87247b4942
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -8,7 +8,7 @@ PluralKit has a Discord server for support and discussion: https://discord.gg/Pc
Running the bot requires Python (specifically version 3.6) and PostgreSQL.
# Configuration
Configuring the bot is done through a configuration file. An example of the configuration format can be seen in [`pluralkit.conf.example`](https://github.com/xSke/PluralKit/blob/master/pluralkit.conf.example).
Configuring the bot is done through a configuration file. An example of the configuration format can be seen below, in the Example PluralKit COnfiguration section.
The following keys are available:
* `token`: the Discord bot token to connect with
@ -17,6 +17,16 @@ The following keys are available:
The environment variables `TOKEN` and `DATABASE_URI` will override the configuration file values when present.
# Example PluralKit Configuration
```
{
"database_uri": "postgres://username:password@hostname:port/database_name",
"token": "BOT_TOKEN_GOES_HERE",
"log_channel": null
}
```
# Running
## Docker
@ -35,4 +45,4 @@ Running PluralKit is pretty easy with Docker. The repository contains a `docker-
* The bot optionally takes a parameter describing the location of the configuration file, defaulting to `./pluralkit.conf`.
# License
This project is under the Apache License, Version 2.0. It is available at the following link: https://www.apache.org/licenses/LICENSE-2.0
This project is under the Apache License, Version 2.0. It is available at the following link: https://www.apache.org/licenses/LICENSE-2.0