From cf666ad364907c2a7229e10ae26ddad93f4ad7a0 Mon Sep 17 00:00:00 2001 From: Michael Oultram Date: Sat, 15 Aug 2015 18:55:46 +0100 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index cbadd15..5bc7ea8 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ MumbleDJ [![Circle CI](https://circleci.com/gh/MichaelOultram/mumbledj/tree/mast * [Commands](#commands) * [Installation](#installation) * [YouTube API Keys](#youtube-api-keys) + * [Soundcloud API Keys](#soundcloud-api-keys) * [Setup Guide](#setup-guide) * [Update Guide](#update-guide) * [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! +###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=""`. Replace \ 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 **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.