Skip to content

Commit

Permalink
Adapted readme for version 6 beta
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnnyCrazy committed Jun 4, 2020
1 parent fb5b81b commit 98e2929
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 44 deletions.
97 changes: 55 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,69 @@
SpotifyAPI-NET
===

[![Build status](https://ci.appveyor.com/api/projects/status/mxpjhw3uli4q0yx1?svg=true)](https://ci.appveyor.com/project/JohnnyCrazy/spotifyapi-net)
<h1 align="center">
<p align="center">SpotifyAPI-NET</p>
<a href="https://johnnycrazy.github.io/SpotifyAPI-NET/">
<img
height="128"
width="128"
src="SpotifyAPI.Docs/static/img/logo.svg"
alt="SpotifyAPI-NET">
</a>
</h1>

> ℹ This README targets Version >= 6.X, which is currently in beta status. For the documentation of version 5.1.1, visit [the docs](https://johnnycrazy.github.io/SpotifyAPI-NET/docs/home)
[![Build status](https://img.shields.io/appveyor/build/JohnnyCrazy/SpotifyAPI-NET/master?style=flat-square)](https://ci.appveyor.com/project/JohnnyCrazy/spotifyapi-net)
![License](https://img.shields.io/github/license/JohnnyCrazy/SpotifyAPI-NET?style=flat-square)
[![SpotifyAPI.Web NuGET](https://img.shields.io/nuget/vpre/SpotifyAPI.Web?label=SpotifyAPI.Web&style=flat-square)](https://www.nuget.org/packages/SpotifyAPI.Web/)
[![SpotifyAPI.Web.Auth NuGET](https://img.shields.io/nuget/vpre/SpotifyAPI.Web.Auth?label=SpotifyAPI.Web.Auth&style=flat-square)](https://www.nuget.org/packages/SpotifyAPI.Web/)

This open source library for the Spotify Web API provides an easy to use interface for .NET based languages, like C# and VisualBasic .NET. By using it you can query general spotify catalog information (tracks, albums and playlists), manage user-related content ("My Library", create and edit playlists) and control the users music players (play, stop, transfer playback, play specific track).

### Features


* ✅ Typed responses and requests to over 74 endpoints. Complete and always up to date.
* ✅ Supports `.NET Standard 2.X`, which includes all major platforms, including mobile:
* `.NET Framework`
* `UWP`
* `.NET Core`
* `Xamarin.Forms`
* ✅ Included `HTTPClient`, but feel free to bring your own!
* ✅ Logging supported
* ✅ Retry Handlers supported
* ✅ Proxy support
* ✅ Pagination support
* ✅ All OAuth2 Authentications supported for use in `ASP .NET` **and** `CLI` apps
* ✅ Modular structure, for easy unit testing

A Wrapper for Spotify's Web API, written in .NET

**Spotify's Web API** ([link](https://developer.spotify.com/web-api/))
> 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.
**SpotifyAPI.Web** [![Nuget SpotifyAPI.Web](https://badge.fury.io/nu/SpotifyAPI.Web.svg)](https://www.nuget.org/packages/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.
### Example

**SpotifyAPI.Web.Auth** [![Nuget SpotifyAPI.Web.Auth](https://badge.fury.io/nu/SpotifyAPI.Web.Auth.svg)](https://www.nuget.org/packages/SpotifyAPI.Web.Auth/)
> A library providing C# implementations of the 3 supported Authentication modes, including `ImplicitGrantAuth`, `AuthorizationCodeAuth` and `CredentialsAuth`
```csharp
using System;
using SpotifyAPI.Web;

### 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/)
class Program
{
static async Task Main()
{
var spotify = new SpotifyClient("YourAccessToken");

### NuGet
You can add the API to your project via [nuget-package](https://www.nuget.org/packages/SpotifyAPI.Web/):
var track = await spotify.Tracks.Get("1s6ux0lNiTziSrd7iUAADH");
Console.WriteLine(track.Name);
}
}
```
Install-Package SpotifyAPI.Web
Install-Package SpotifyAPI.Web.Auth

//or
More examples can be found on [the website](https://johnnycrazy.github.io/SpotifyAPI-NET/docs/next/introduction) and in the `SpotifyAPI.Web.Examples` directory.

Install-Package SpotifyAPI.Web -pre
Install-Package SpotifyAPI.Web.Auth -pre
```

### Example
### Docs and Usage

```c#
using SpotifyAPI.Web.Enums;
using SpotifyAPI.Web.Models;
More Information, Installation-Instructions, Examples, Guides can be found at [johnnycrazy.github.io/SpotifyAPI-NET/](http://johnnycrazy.github.io/SpotifyAPI-NET/)

public static async void Example()
{
SpotifyWebAPI api = new SpotifyWebAPI
{
AccessToken = "XX?X?X",
TokenType = "Bearer"
};

FullTrack track = await api.GetTrackAsync("1eV81a6H4xDdpi8r2C4tQT");
if(!track.HasError()) {
Console.WriteLine(track.Name);
}
}
```
### Installation

Installation Instructions can be found in the [Getting Started Guide](https://johnnycrazy.github.io/SpotifyAPI-NET/docs/next/getting_started)

### Donations

Expand Down
Loading

0 comments on commit 98e2929

Please sign in to comment.