From f9247c5417f09115c5c0eb9ce3efe097e29e4803 Mon Sep 17 00:00:00 2001
From: mgerb42 <mgerb42@gmail.com>
Date: Fri, 7 Apr 2017 23:46:26 -0500
Subject: [PATCH] update readme

---
 config.template.json |  1 +
 readme.md            | 30 ++++++++++++++++++++----------
 2 files changed, 21 insertions(+), 10 deletions(-)

diff --git a/config.template.json b/config.template.json
index 57f8f05..ff5f56b 100644
--- a/config.template.json
+++ b/config.template.json
@@ -1,3 +1,4 @@
+// IMPORTANT - rename this file to config.json and remove this line
 {
     "Token": "",
     "BotPrefix": "#",
diff --git a/readme.md b/readme.md
index fec6820..10e0176 100644
--- a/readme.md
+++ b/readme.md
@@ -4,13 +4,30 @@ This is a soundboard bot for discord. The back end is in GoLang and the front en
 
 <img src="http://i.imgur.com/jtAyJZ1.png"/>
 
-## Dependencies
+## How to use
+
+NOTE: Currently the binaries in the release package only run on linux. Check them out [here](https://github.com/mgerb/go-discord-bot/releases)
+
+- download bot.zip and extract everything
+- rename config.template.json to config.json
+- add your bot token and preferred upload password (leave as is for no password)
+- run the bot with `./bot` (you may need to use sudo if you leave it on port 80)
+
+### NOTE
+
+If you get a permissions error with ffmpeg:
+`sudo chmod +x dist/ffmpeg`
+
+Sounds are stored in the `dist/sounds` directory. You may copy files directly to this folder rather than uploading through the site.
+
+## Building from Source
+
+### Dependencies
 - Go
 - Yarn (or npm - makefile will need to be adjusted)
 - make
 
-## How to use
-
+### Compiling
 - Make sure dependencies are installed
 - `make all`
 - Rename the `config.template.json` to `config.json`
@@ -20,13 +37,6 @@ This is a soundboard bot for discord. The back end is in GoLang and the front en
 - upload files
 - success!
 
-### NOTE
-
-If you get a permissions error with ffmpeg:
-`sudo chmod +x dist/ffmpeg`
-
-Sounds are stored in the `dist/sounds` directory. You may copy files directly to this folder rather than uploading through the site.
-
 ### Windows
 I've only compiled and run this on linux, but it should work on windows with little changes.
 An ffmpeg executable is required. The linux executable is included.