containers/mumbledj
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge branch 'master' of https://github.com/MichaelOultram/mumbledj

Browse source
This commit is contained in:
MichaelOultram 2015-08-15 19:18:37 +01:00
parent 14ae00973d cf666ad364
commit c4a32a0ff6
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -7,6 +7,7 @@ MumbleDJ [![Circle CI](https://circleci.com/gh/MichaelOultram/mumbledj/tree/mast
* [Commands](#commands) * [Commands](#commands)
* [Installation](#installation) * [Installation](#installation)
* [YouTube API Keys](#youtube-api-keys) * [YouTube API Keys](#youtube-api-keys)
* [Soundcloud API Keys](#soundcloud-api-keys)
* [Setup Guide](#setup-guide) * [Setup Guide](#setup-guide)
* [Update Guide](#update-guide) * [Update Guide](#update-guide)
* [Troubleshooting](#troubleshooting) * [Troubleshooting](#troubleshooting)
@ -87,6 +88,19 @@ Effective April 20th, 2015, all requests to YouTube's API must use v3 of their A
**8)** Close your current terminal window and open another one up. You should be able to use MumbleDJ now! **8)** Close your current terminal window and open another one up. You should be able to use MumbleDJ now!
###SOUNDCLOUD API KEYS
A soundcloud API key is required for soundcloud integration. If no soundcloud api key is found, then the service will be disabled (youtube links will still work however).
**1)** Login/signup for a soundcloud account on [https://soundcloud.com](https://soundcloud.com)
**2)** Now to get the API key create a new app here: [http://soundcloud.com/you/apps/new](http://soundcloud.com/you/apps/new)
**3)** Copy the Client ID (not the Client Secret)
**4)** Open up `~/.bashrc` with your favorite text editor (or `~/.zshrc` if you use `zsh`). Add the following line to the bottom: `export SOUNDCLOUD_API_KEY="<your_key_here>"`. Replace \<your_key_here\> with your API key.
**5)** Close your current terminal window and open another one up. You should be able to use soundcloud on MumbleDJ now!
###SETUP GUIDE ###SETUP GUIDE
**1)** Install and correctly configure [`Go`](https://golang.org/) (1.4 or higher). Specifically, make sure to follow [this guide](https://golang.org/doc/code.html) and set the `GOPATH` environment variable properly. **1)** Install and correctly configure [`Go`](https://golang.org/) (1.4 or higher). Specifically, make sure to follow [this guide](https://golang.org/doc/code.html) and set the `GOPATH` environment variable properly.