Add README

Xe · Nov 26, 2017 · de3f3c9 · de3f3c9
1 parent 26d709b
commit de3f3c9
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+# disrelay
+
+## Configuration
+
+Create a file named `.env` that contains the following key->value pairs:
+
+```shell
+DISCORD_TOKEN=<discord token here>
+CHANNEL_MAP=<discord channel id>:<irc channel name without hash>,269624426272653312:geek
+IRC_NICK=Ryleth
+IRC_USER=flagatn
+IRC_SERVER=irc.ponychat.net:6697
+IRC_PASS=hunter2
+IRC_TLS=true
+```
+
+## Running
+
+```shell
+$ docker service create --name disrelay --env-file .env xena/disrelay:1.0
+```