From 734c05175947b45202dfc3e47d1a7c89b38dbb49 Mon Sep 17 00:00:00 2001 From: Jonas Dellinger Date: Sat, 22 Dec 2018 21:27:43 +0100 Subject: [PATCH] Updated Readme and doc styles --- README.md | 29 ++++++++++++++++++++++++++-- SpotifyAPI.Docs/docs/index.md | 2 +- SpotifyAPI.Docs/mytheme/css/base.css | 7 +++++++ 3 files changed, 35 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c94eb202..ae40a070 100644 --- a/README.md +++ b/README.md @@ -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. > The API also provides access to user-related data such as playlists and music saved in a “Your Music” library, subject to user’s 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/) @@ -30,6 +34,27 @@ Install-Package SpotifyAPI.Web -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 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! diff --git a/SpotifyAPI.Docs/docs/index.md b/SpotifyAPI.Docs/docs/index.md index 72d028e0..a1480097 100644 --- a/SpotifyAPI.Docs/docs/index.md +++ b/SpotifyAPI.Docs/docs/index.md @@ -14,7 +14,7 @@ This project, written in C#/.NET, provides 2 libraries for an easier usage of th **SpotifyAPI.Web.Auth** > A library providing C# implementations of the 3 supported Authentication modes, including `ImplicitGrantAuth`, `AuthorizationCodeAuth` and `CredentialsAuth` ---- +--- ## Installing diff --git a/SpotifyAPI.Docs/mytheme/css/base.css b/SpotifyAPI.Docs/mytheme/css/base.css index d59fd720..a38bceb0 100644 --- a/SpotifyAPI.Docs/mytheme/css/base.css +++ b/SpotifyAPI.Docs/mytheme/css/base.css @@ -1,3 +1,10 @@ +@media (min-width: 1200px) { + .container { + width: 100%; !important; + } +} + + body { padding-top: 70px; }