diff --git a/.gitignore b/.gitignore index 5234f73..131ad17 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ node_modules -tapbox-7d491-firebase-adminsdk-ijkiy-6aca66d503.json \ No newline at end of file +tapbox-7d491-firebase-adminsdk-ijkiy-6aca66d503.json +screenshots \ No newline at end of file diff --git a/README.md b/README.md index 913ad3f..e0c6a5f 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ Simply create a Slash Command, such as `/juke`, which accepts a track name (also /juke Ramble On – Led Zeppelin /juke Ramble On + +GIF of how it works ## Installation @@ -12,7 +14,7 @@ Simply create a Slash Command, such as `/juke`, which accepts a track name (also First you'll want to create your Slack Slash Command, which you can do by going to your [Slash Commands page](https://my.slack.com/services/new/bots). -{{Image for Slack}} +Slack's settings for Slack command During setup, have your slash command or outgoing webhook submit a POST to your app's `/store` endpoint, e.g. `https://app-name.herokuapp.com/store`. @@ -27,7 +29,7 @@ If you want to post the song that was recently added, go to [Your Slack's app di Head over to [Spotify's Developer Site](http://developer.spotify.com) and create a new Application. Make sure you add whatever slackbox's callback URI as a valid callback URI. If you're running locally, this will be `http://localhost:5000/callback` or on Heroku `https://app-name.herokuapp.com/callback` -{{Image for Spotify}} +Spotify's Developer page Make a note of the `key`, `secret` and `callback URI` too, as you'll need these later as well. @@ -41,7 +43,7 @@ If you create an app on Heroku for free, the app will go to sleep after 30 minut To create a Firebase database, create an account for free, add project with same name as on Heroku, create a database, and then generate a private key to get your `Firebase service account key` JSON file. You will need this file in the root of your project as it contains the private key to your DB. -{{Image for Firebase}} +Firebase DB settings #### Cron job diff --git a/screenshots/firebase_settings.jpg b/screenshots/firebase_settings.jpg new file mode 100644 index 0000000..a69a6f0 Binary files /dev/null and b/screenshots/firebase_settings.jpg differ diff --git a/screenshots/slack_settings.jpg b/screenshots/slack_settings.jpg new file mode 100644 index 0000000..5f77996 Binary files /dev/null and b/screenshots/slack_settings.jpg differ diff --git a/screenshots/spotify_settings.jpg b/screenshots/spotify_settings.jpg new file mode 100644 index 0000000..79872c3 Binary files /dev/null and b/screenshots/spotify_settings.jpg differ diff --git a/screenshots/tapbox_test.gif b/screenshots/tapbox_test.gif new file mode 100644 index 0000000..93fea01 Binary files /dev/null and b/screenshots/tapbox_test.gif differ