From 217f61732422c162e56944e1f846a7f1f95d07d4 Mon Sep 17 00:00:00 2001
From: Matthieu Grieger <matthieugrieger@gmail.com>
Date: Sat, 20 Dec 2014 21:21:33 -0800
Subject: [PATCH] Update README with Usage and Installation sections

---
 README.md | 33 ++++++++++++++++++++++++++++++---
 1 file changed, 30 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index e0f58d0..45ebe08 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,37 @@ A Mumble bot that plays music fetched from YouTube videos. I have decided to exp
 
 And yes, I know that technically this is v3. The Ruby implementation had problems with high CPU usage and choppy audio which I couldn't seem to figure out.
 
-## Author
+## USAGE
+#####`$ mumbledj -server=localhost -port=64738 -username=MumbleDJ -password="" -channel=root`  
+All parameters are optional, the example above shows the default values for each field.
+
+## INSTALLATION
+Installation for v2 of MumbleDJ is much easier than it was before, due to the reduced dependency list and a `Makefile` which automates some of the process.  
+
+**NOTE:** This bot was designed for use on Linux machines. If you wish to run the bot on another OS, it will require tweaking and is not something I will be able to help with.
+
+**SETUP GUIDE**  
+**1)** Install and correctly configure [`Go`](https://golang.org/). Specifically, make sure to follow [this guide](https://golang.org/doc/code.html) and set the `GOPATH` environment variable properly.
+
+**2)** Install [`ffmpeg`](https://www.ffmpeg.org/) if it is not already installed on your system.
+
+**3)** Clone the `MumbleDJ` repository.
+
+**4)** `cd` into the `MumbleDJ` repository directory and execute the following commands: 
+```
+$ make install_deps
+$ make
+$ make install
+```
+
+**5)** Edit `~/.mumbledj/config/mumbledj.gcfg` to your liking. This file will be overwritten if the config file structure is changed in a commit, but a backup is always stored at `~/.mumbledj/config/mumbledj_backup.gcfg`.
+
+**6)** Execute the command shown at the top of this `README` document with your credentials, and the bot should be up and running!
+
+## AUTHOR
 [Matthieu Grieger](http://matthieugrieger.com)
 
-## License
+## LICENSE
 ```
 The MIT License (MIT)
 
@@ -32,7 +59,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ```
 
-## Thanks
+## THANKS
 * All those who contribute to [Mumble](https://github.com/mumble-voip/mumble).
 * [Tim Cooper](https://github.com/bontibon) for [gumble](https://github.com/layeh/gumble).
 * [Ricardo Garcia](https://github.com/rg3) for [youtube-dl](https://github.com/rg3/youtube-dl).