update readme and testing documentation

Signed-off-by: Adam Ratzman <[email protected]>

Author: adamint

CONTRIBUTING.md

@@ -5,6 +5,7 @@ email, or any other method with the owners of this repository before making a ch
 
 Please note we have a code of conduct, please follow it in all your interactions with the project.
 
+
 ## Testing
 Please see [testing.md](TESTING.md) for full testing instructions. Your contributions should be able to pass every test
 

README.md

@@ -6,7 +6,32 @@
 
 This is the [Kotlin](https://kotlinlang.org/) implementation of the [Spotify Web API](https://developer.spotify.com/web-api/)
 
-## Install it
+## Table of Contents
+* [Library installing](#library-installing)
+    + [JVM, Android, JS](#jvm-android-js)
+    + [Android information](#android)
+* [Documentation](#documentation)
+* [Need help, have a question, or want to contribute?](#have-a-question)
+* [Creating a new api instance](#creating-a-new-api-instance)
+    + [SpotifyAppApi](#spotifyappapi)
+    + [SpotifyClientApi](#spotifyclientapi)
+        * [PKCE](#pkce)
+        * [Non-PKCE](#non-pkce-backend-applications-requires-client-secret)
+    + [SpotifyImplicitGrantApi](#spotifyimplicitgrantapi)
+    + [SpotifyApiBuilder block & setting API options](#spotifyapibuilder-block--setting-api-options)
+        * [API options](#api-options)
+    + [Using the API](#using-the-api)
+* [Tips](#tips)
+    + [Building the API](#building-the-api)
+    + [What is the SpotifyRestAction class?](#what-is-the-spotifyrestaction-class)
+    + [SpotifyRestPagingAction](#spotifyrestpagingaction)
+* [Notes](#notes)
+    + [The benefits of LinkedResults, PagingObjects, and Cursor-based Paging Objects](#the-benefits-of-linkedresults-pagingobjects-and-cursor-based-paging-objects)
+    + [Generic Requests](#generic-request)
+    + [Track Relinking](#track-relinking)
+* [Contributing](#contributing)
+
+## Library installing
 
 ### JVM, Android, JS
 ```
@@ -368,7 +393,7 @@ for `AbstractPagingObject` (`PagingObject` and `CursorBasedPagingObject`). This
 but you also have the ability to retrieve *all* of its items or linked PagingObjects, or a *subset* of its items or linked PagingObjects with one call, with 
 a single method call to `getAllItems()` or `getAllPagingObjects()`, or `getWithNext(total: Int, context: CoroutineContext = Dispatchers.Default)` or `getWithNextItems(total: Int, context: CoroutineContext = Dispatchers.Default)` respectively
 
-## Design Notes
+## Notes
 ### The benefits of LinkedResults, PagingObjects, and Cursor-based Paging Objects
 Spotify provides these three object models in order to simplify our lives as developers. So let's see what we
 can do with them!
@@ -433,5 +458,5 @@ will be populated with the href, uri, and, most importantly, the id of the track
 You can then use this track in `SpotifyClientApi` endpoints such as playing or saving the track, knowing that it will be playable 
 in your market!
 
-### Contributing
+## Contributing
 See [CONTRIBUTING.md](CONTRIBUTING.md)

TESTING.md

@@ -7,42 +7,20 @@ You must create a Spotify application [here](https://developer.spotify.com/dashb
 
 To run **only** public endpoint tests, run
 
-`gradle check`
+`gradle jvmTest` and `gradle testDebugUnitTest`
 
 Note: You must have `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET` as environment variables.
 
 To run **all** tests, you need a valid Spotify application, redirect uri, and token string. use:
 
-`gradle check`
+`gradle jvmTest` and `gradle testDebugUnitTest`
 
 Note: In addition to `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET`, you also must have the following environment 
 variables set up: `SPOTIFY_REDIRECT_URI` and `SPOTIFY_TOKEN_STRING`
 
 Some tests may fail if you do not allow access to all required scopes. To mitigate this, you can individually grant 
 each scope or use the following code snippet to print out the Spotify token string (given a generated authorization code)
 
-**How to generate an authorization URL**
-```kotlin
-import com.adamratzman.spotify.SpotifyScope
-val api = spotifyClientApi(
-        "SPOTIFY_CLIENT_ID",
-        "SPOTIFY_CLIENT_SECRET",
-        "SPOTIFY_REDIRECT_URI") {
-    authorization {
-        tokenString = "SPOTIFY_TOKEN_STRING"
-    }
-}.getAuthorizationUrl(*SpotifyScope.values())
-
-```
-
-**How to get a Spotify token**
-```kotlin
-val api = spotifyClientApi(
-        "SPOTIFY_CLIENT_ID",
-        "SPOTIFY_CLIENT_SECRET",
-        "SPOTIFY_REDIRECT_URI") {
-    authorization {
-        tokenString = "SPOTIFY_TOKEN_STRING"
-    }
-}.build().token.accessToken.let { println(it) }
-```
+To build the maven artifact locally, you will need to follow these steps:
+- Create `gradle.properties` if it doesn't exist already.
+- Follow [this guide](https://gist.github.com/phit/bd3c6d156a2fa5f3b1bc15fa94b3256c). Instead of `.gpg` extension, use `.kbx` for your secring.