diff --git a/README.md b/README.md index bd49893..7ee5faa 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,34 @@ ***In a very experimental stage.*** +## Setup + +### How to Generate an API Key from Spotify Dashboard + +If you want to use Spotify's API to create applications that interact with their music streaming service, you will need an API key. Here's how you can generate one from the Spotify Dashboard: + +1. Go to the [Spotify Developer Dashboard](https://developer.spotify.com/dashboard/) and log in with your Spotify account credentials. + +2. Click on the "Create an App" button to create a new application. + + ![Create an App](./extras/create.png) + +3. Give your application a name and description, and agree to the terms of service. In the `Redirect URI` section add `http://localhost:8080/callback` as a callback URL. This is necessary for the OAuth 2.0 authentication flow to work. Click on "Create" to proceed. + ![Create an App Form](./extras/create_form.png) + +4. On the next page, you'll see the details of your newly created application. In the Settings Look for the section labeled "Client ID" and click on the "Show Client Secret" button. + +5. You will now see your Client ID and Client Secret. You will need both of these to use the Spotify API in `gspt` + +```bash +$ export SPOTIFY_ID= # client id +$ export SPOTIFY_SECRET= # client secret +``` + +7. After this you can just run `gspt`. And follow the link that it generates, and Login. + +```bash +$ gspt +``` + +--- diff --git a/extras/create.png b/extras/create.png new file mode 100644 index 0000000..b2b28ad Binary files /dev/null and b/extras/create.png differ diff --git a/extras/create_form.png b/extras/create_form.png new file mode 100644 index 0000000..3813c7d Binary files /dev/null and b/extras/create_form.png differ