Update documentation

Author: sonallux

README.md

@@ -23,7 +23,7 @@ This monorepo contains tools for parsing the [Spotify Web API Reference](https:/
 
 
 ## Versioning
-Unfortunately Spotify does not provide any version information with their web API reference documentation. Therefore, I try to follow [semantic versioning](https://semver.org) when releasing new versions. But keep in mind that Spotify can update their Web API endpoints at any time, so it is best to always use the latest major version of these libraries. Only updating to a newer patch or minor release even if there is a new major release might be less work for you, but it also imposes to risk of running into issues because Spotify has made a breaking change to their Web API.
+Unfortunately Spotify does not provide any version information with their web API reference documentation. Therefore, I try to follow [semantic versioning](https://semver.org) when releasing new versions. But keep in mind that Spotify can update their Web API endpoints at any time so that your code can potentially break. Therefore, it is best to always use the very latest version of these libraries. Not updating does always impose the risk of running into issues because Spotify has made a breaking change to their Web API.
 
 ## Disclaimer
 Because the wrappers are only based on the Spotify web API reference, there might be difference to the actual behaviour of the actual Spotify Web API endpoints. Also, neither do I have any connections to Spotify nor am I an employee at Spotify.

spotify-web-api-java/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project tries to follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+See [here](https://github.com/sonallux/spotify-web-api#versioning) why we can not guarantee strict semantic versioning.
+
+## [Unreleased]
+Complete rewrite of the library by generating the model and endpoints from the Spotify reference documentation. This results in a lot of breaking changes around naming of objects, properties, endpoints and parameters. Other notable changes:
+
+- Renamed the maven groupId from `de.jsone-studios` to `de.sonallux.spotify`
+- Renamed package from `de.jsone_studios.wrapper.spotify` to `de.sonallux.spotify.api`
+- Removed `SpotifyApi` interface in favour of a `SpotifyWebApi`
+- `SpotifyWebApi` uses the builder pattern to create an instance
+- Replaced [retrofit](https://square.github.io/retrofit) by a custom wrapper around [OkHttp](https://square.github.io/okhttp)
+- Requests are now created with a builder style api for optional parameters. For example:
+```java
+ApiCall<?> call1 = spotifyWebApi.getXApi().getX("requiredParam").build();
+ApiCall<?> call2 = spotifyWebApi.getXApi().getX("requiredParam").optionalParam1("Y").build();
+```
+- Removed `SpotifyApi.callApi()` in favour of an `executeCall()` method on the new `ApiCall` class
+- Removed `SpotifyApi.callApiAndReturnBody()` in favour of an `execute()` method on the new `ApiCall` class
+- Added support for all authorization flows. See [here](https://github.com/sonallux/spotify-web-api/tree/master/spotify-web-api-java#authorization) for more details.
+
+## [1.x.x]
+The changelog of the `1.x.x` version of the `spotify-web-api-java` can be found [here](https://github.com/sonallux/spotify-web-api-java/blob/master/CHANGELOG.md).

spotify-web-api-java/README.md

@@ -21,11 +21,10 @@ compile 'de.sonallux.spotify:spotify-web-api-java:2.0.0'
 
 ## General usage
 ```java
-ApiAuthorizationProvider authProvider = new SimpleApiAuthorizationProvider("<your access token>");
-SpotifyApi spotifyApi = new SpotifyApi(authProvider);
+var authProvider = new SimpleApiAuthorizationProvider("<your access token>");
+var spotifyApi = SpotifyWebApi.builder().authorization(authProvider).build();
 
-Call<Artist> getArtistCall = spotifyApi.getArtistsApi().getArtist("<artist id>");
-Artist artist = spotifyApi.callApiAndReturnBody(getArtistCall);
+var artist = spotifyApi.getArtistsApi().getArtist("<artist id>").build().execute();
 System.out.println(artist.getName());
 ```