Create README.md

This commit is contained in:
Kepoor Hampond 2017-06-10 19:05:06 -07:00 committed by GitHub
parent 46aeaa8bfa
commit 61f318ba99

View file

@ -17,6 +17,13 @@ A tool to download your music with metadata. It uses [Spotify](https://www.spoti
Works with Python 2 and 3.
## Install
```
$ sudo pip install irs
```
**You will need to have some Spotify tokens, the instructions to set them up are [here](https://github.com/kepoorhampond/irs#spotify-tokens).**
## Demo and Usages
This is a demo of the CLI displayling its features:
@ -57,13 +64,6 @@ $ irs -s "Bohemian Rhapsody"
$ irs -p "Best Nirvana"
```
## Install
```
$ sudo pip install irs
```
**You will need to have some Spotify tokens, the instructions to set them up are [here](https://github.com/kepoorhampond/irs#spotify-tokens).**
## Spotify Tokens
To download metadata through spotify, you'll want to head to their Dev Apps page, [here](https://developer.spotify.com/my-applications/). After doing that you'll want to create a new app. Name it whatever you want and then once you've done that, find the `Client ID` and `Client Secret` keys. You'll want to take those keys and paste them into your system's environment variables as `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET`, correspondingly. Viola! You can now download metadata with IRS!