Skip to content

Commit 734c051

Browse files
author
Jonas Dellinger
committed
Updated Readme and doc styles
1 parent 18863f1 commit 734c051

3 files changed

Lines changed: 35 additions & 3 deletions

File tree

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,13 @@ A Wrapper for Spotify's Web API, written in .NET
1212
> Based on simple REST principles, our Web API endpoints return metadata in JSON format about artists, albums, and tracks directly from the Spotify catalogue.
1313
> 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.
1414
15-
### Docs and Usage
15+
**SpotifyAPI.Web**
16+
> 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.
17+
18+
**SpotifyAPI.Web.Auth**
19+
> A library providing C# implementations of the 3 supported Authentication modes, including `ImplicitGrantAuth`, `AuthorizationCodeAuth` and `CredentialsAuth`
1620
17-
> Docs are currently outdated and are being worked on. Please refer to the example Project for a rough overview.
21+
### Docs and Usage
1822

1923
More Information, Installation-Instructions, Examples and API-Reference can be found at [github.io/SpotifyAPI-Net/](http://johnnycrazy.github.io/SpotifyAPI-NET/)
2024

@@ -30,6 +34,27 @@ Install-Package SpotifyAPI.Web -pre
3034
Install-Package SpotifyAPI.Web.Auth -pre
3135
```
3236

37+
### Example
38+
39+
```c#
40+
using SpotifyAPI.Web.Enums;
41+
using SpotifyAPI.Web.Models;
42+
43+
public static async void Example()
44+
{
45+
SpotifyWebAPI api = new SpotifyWebAPI
46+
{
47+
AccessToken = "XX?X?X",
48+
TokenType = "Bearer"
49+
};
50+
51+
PrivateProfile profile = await api.GetPrivateProfileAsync();
52+
if(!profile.HasError()) {
53+
Console.WriteLine(profile.DisplayName);
54+
}
55+
}
56+
```
57+
3358
### Donations
3459

3560
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!

SpotifyAPI.Docs/docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This project, written in C#/.NET, provides 2 libraries for an easier usage of th
1414
**SpotifyAPI.Web.Auth**
1515
> A library providing C# implementations of the 3 supported Authentication modes, including `ImplicitGrantAuth`, `AuthorizationCodeAuth` and `CredentialsAuth`
1616
17-
---
17+
---
1818

1919
## Installing
2020

SpotifyAPI.Docs/mytheme/css/base.css

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
@media (min-width: 1200px) {
2+
.container {
3+
width: 100%; !important;
4+
}
5+
}
6+
7+
18
body {
29
padding-top: 70px;
310
}

0 commit comments

Comments
 (0)