update readme

zku · Jun 17, 2024 · fff41e5 · fff41e5
1 parent bd12607
commit fff41e5
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,10 +2,30 @@
 
 Simple self-hosted Discord bot to facilitate moving players to the Townsquare and to their private night cottages.
 
+# Discord Server settings
+
+You need 2 voice channel categories, one for the day phase, and one for the night phase. The night phase cottages should be marked as private so nobody besides the story teller can see them.
+
+You also need a story teller role on your server. Only users with this role can control the bot.
+
+![discord](img/discord.png)
+
+Use the `/buttons` command to get the movement buttons. These buttons will persist, so there is typically no need to re-run the slash command.
+
+![buttons](img/buttons.png)
+
 # Setting up your own Discord Bot
 
-TODO
+Create a new Discord Bot [here](https://discord.com/developers) and add it to your server.
+
+![settings1](img/settings1.png)
+
+![settings2](img/settings2.png)
 
 # Running the Bot
 
-TODO
+```golang
+go run . -config="/path/to/.config.json"
+```
+
+The config can also be specified via environment variables. See `config.go` for more information.
diff --git a/img/buttons.png b/img/buttons.png
diff --git a/img/discord.png b/img/discord.png
diff --git a/img/settings1.png b/img/settings1.png
diff --git a/img/settings2.png b/img/settings2.png