Updated Readme and doc styles

This commit is contained in:
Jonas Dellinger 2018-12-22 21:27:43 +01:00
parent 18863f1733
commit 734c051759
3 changed files with 35 additions and 3 deletions

View File

@ -12,9 +12,13 @@ A Wrapper for Spotify's Web API, written in .NET
> Based on simple REST principles, our Web API endpoints return metadata in JSON format about artists, albums, and tracks directly from the Spotify catalogue. > Based on simple REST principles, our Web API endpoints return metadata in JSON format about artists, albums, and tracks directly from the Spotify catalogue.
> The API also provides access to user-related data such as playlists and music saved in a “Your Music” library, subject to users authorization. > The API also provides access to user-related data such as playlists and music saved in a “Your Music” library, subject to users authorization.
### Docs and Usage **SpotifyAPI.Web**
> A wrapper around Spotify's Web API, providing sync and async methods to query all possible endpoints. Results are returned as typed class instances, allowing property-based access.
> Docs are currently outdated and are being worked on. Please refer to the example Project for a rough overview. **SpotifyAPI.Web.Auth**
> A library providing C# implementations of the 3 supported Authentication modes, including `ImplicitGrantAuth`, `AuthorizationCodeAuth` and `CredentialsAuth`
### Docs and Usage
More Information, Installation-Instructions, Examples and API-Reference can be found at [github.io/SpotifyAPI-Net/](http://johnnycrazy.github.io/SpotifyAPI-NET/) More Information, Installation-Instructions, Examples and API-Reference can be found at [github.io/SpotifyAPI-Net/](http://johnnycrazy.github.io/SpotifyAPI-NET/)
@ -30,6 +34,27 @@ Install-Package SpotifyAPI.Web -pre
Install-Package SpotifyAPI.Web.Auth -pre Install-Package SpotifyAPI.Web.Auth -pre
``` ```
### Example
```c#
using SpotifyAPI.Web.Enums;
using SpotifyAPI.Web.Models;
public static async void Example()
{
SpotifyWebAPI api = new SpotifyWebAPI
{
AccessToken = "XX?X?X",
TokenType = "Bearer"
};
PrivateProfile profile = await api.GetPrivateProfileAsync();
if(!profile.HasError()) {
Console.WriteLine(profile.DisplayName);
}
}
```
### Donations ### Donations
If you want to support this project or my work in general, you can donate a buck or two via the link below. However, this will be always optional! If you want to support this project or my work in general, you can donate a buck or two via the link below. However, this will be always optional!

View File

@ -1,3 +1,10 @@
@media (min-width: 1200px) {
.container {
width: 100%; !important;
}
}
body { body {
padding-top: 70px; padding-top: 70px;
} }