liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Ske 2020-02-12 14:39:00 +01:00
parent b68e221fc6
commit c10e197c39
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -6,7 +6,7 @@ PluralKit is a Discord bot meant for plural communities. It has features like me
PluralKit has a Discord server for support, feedback, and discussion: https://discord.gg/PczBt78 PluralKit has a Discord server for support, feedback, and discussion: https://discord.gg/PczBt78
# Requirements # Requirements
Running the bot requires [.NET Core](https://dotnet.microsoft.com/download) (v2.2) and a PostgreSQL database. Running the bot requires [.NET Core](https://dotnet.microsoft.com/download) (v3.1) and a PostgreSQL database.
# Configuration # Configuration
Configuring the bot is done through a JSON 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 JSON 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).
@ -39,7 +39,7 @@ $ docker-compose up -d
``` ```
## Manually ## Manually
* Install the .NET Core 2.2 SDK (see https://dotnet.microsoft.com/download) * Install the .NET Core 3.1 SDK (see https://dotnet.microsoft.com/download)
* Clone this repository: `git clone https://github.com/xSke/PluralKit` * Clone this repository: `git clone https://github.com/xSke/PluralKit`
* Create and fill in a `pluralkit.conf` file in the same directory as `docker-compose.yml` * Create and fill in a `pluralkit.conf` file in the same directory as `docker-compose.yml`
* Run the bot: `dotnet run --project PluralKit.Bot` * Run the bot: `dotnet run --project PluralKit.Bot`
@ -55,6 +55,7 @@ $ bundle exec jekyll build
``` ```
To run an auto-reloading server, substitute the last command with: To run an auto-reloading server, substitute the last command with:
$ bundle exec jekyll serve $ bundle exec jekyll serve
# License # License