From 2e4d111242b2b450f8421241288eee32b65c3c72 Mon Sep 17 00:00:00 2001
From: Ske <voltasalt@gmail.com>
Date: Mon, 1 Jul 2019 01:04:35 +0200
Subject: [PATCH] Update README for rewrite

---
 README.md          | 27 +++++++++++++--------------
 docker-compose.yml |  3 ++-
 2 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index d22338e7..d94b6f81 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,21 @@
 # PluralKit
-
 PluralKit is a Discord bot meant for plural communities. It has features like message proxying through webhooks, switch tracking, system and member profiles, and more.
 
-PluralKit has a Discord server for support and discussion: https://discord.gg/PczBt78 
+**Do you just want to add PluralKit to your server? If so, you don't need any of this. Use the bot's invite link: https://discordapp.com/oauth2/authorize?client_id=466378653216014359&scope=bot&permissions=536995904**
+PluralKit has a Discord server for support, feedback, and discussion: https://discord.gg/PczBt78 
 
 # Requirements
-Running the bot requires Python (specifically version 3.6) and PostgreSQL.
+Running the bot requires [.NET Core](https://dotnet.microsoft.com/download) (>=2.2) and a PostgreSQL database.
 
 # 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 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).
+The configuration file needs to be placed in the bot's working directory (usually the repository root) and must be called `pluralkit.conf`.
+
+The configuration file is in JSON format (albeit with a `.conf` extension), and the following keys (using `.` to indicate a nested object level) are available:
 
 The following keys are available:
-* `token`: the Discord bot token to connect with
-* `database_uri`: the URI of the database to connect to (format: `postgres://username:password@hostname:port/database_name`)
-* `log_channel` (optional): a Discord channel ID the bot will post exception tracebacks in (make this private!)
-
-The environment variables `TOKEN` and `DATABASE_URI` will override the configuration file values when present.
+* `PluralKit.Database`: the URI of the database to connect to (in [ADO.NET Npgsql format](https://www.connectionstrings.com/npgsql/): `postgres://username:password@hostname:port/database_name`)
+* `PluralKit.Bot.Token`: the Discord bot token to connect with
 
 # Running
 
@@ -23,16 +23,15 @@ The environment variables `TOKEN` and `DATABASE_URI` will override the configura
 Running PluralKit is pretty easy with Docker. The repository contains a `docker-compose.yml` file ready to use.
 
 * Clone this repository: `git clone https://github.com/xSke/PluralKit`
-* Create a `pluralkit.conf` file in the same directory as `docker-compose.yml` containing at least a `token` field
+* Create a `pluralkit.conf` file in the same directory as `docker-compose.yml` containing at least a `PluralKit.Bot.Token` field
 * Build the bot: `docker-compose build`
 * Run the bot: `docker-compose up`
 
 ## Manually
+* Install the .NET Core 2.2 SDK (see https://dotnet.microsoft.com/download)
 * Clone this repository: `git clone https://github.com/xSke/PluralKit`
-* Create a virtualenv: `virtualenv --python=python3.6 venv`
-* Install dependencies: `venv/bin/pip install -r requirements.txt`
-* Run PluralKit with the config file: `venv/bin/python src/bot_main.py`
-  * The bot optionally takes a parameter describing the location of the configuration file, defaulting to `./pluralkit.conf`.
+* Run the bot: `dotnet run --project PluralKit.Bot`
+
 
 # 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
\ No newline at end of file
diff --git a/docker-compose.yml b/docker-compose.yml
index ed2ca8d2..263ea55d 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -4,8 +4,9 @@ services:
     build: .
     entrypoint: ["dotnet", "run", "--project", "PluralKit.Bot"]
     environment:
-      - "PluralKit:Bot:Token"
       - "PluralKit:Database=Host=db;Username=postgres;Password=postgres;Database=postgres"
+    volumes:
+      - "./pluralkit.conf:/app/pluralkit.conf:ro"
     links:
       - db
   web: