Spotify.NET/SpotifyAPI.Docs/docs/index.md

46 lines
1.8 KiB
Markdown
Raw Normal View History

2016-08-20 11:49:09 +01:00
# SpotifyAPI-NET Documentation
## About
2018-03-25 18:56:59 +01:00
This project, written in C#/.NET, provides 2 libraries for an easier usage of the Spotify Web API
2016-08-20 11:49:09 +01:00
**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 users authorization.
**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.
2016-08-20 11:49:09 +01:00
**SpotifyAPI.Web.Auth**
> A library providing C# implementations of the 3 supported Authentication modes, including `ImplicitGrantAuth`, `AuthorizationCodeAuth` and `CredentialsAuth`
2016-08-20 11:49:09 +01:00
---
## Installing
2018-03-25 18:56:59 +01:00
2016-08-20 11:49:09 +01:00
* Via NuGet Package:
```cs
Install-Package SpotifyAPI.Web
Install-Package SpotifyAPI.Web.Auth
2016-08-20 11:49:09 +01:00
```
* Download the latest binaries on the [GitHub Release Page](https://github.com/JohnnyCrazy/SpotifyAPI-NET/releases) and add it to your Project
* Clone the Repo and build the project yourself.
2016-08-20 11:49:09 +01:00
---
## Projects
2018-03-25 18:56:59 +01:00
### [Spofy](https://github.com/eltoncezar/Spofy) by [@eltoncezar](https://github.com/eltoncezar)
2016-08-20 11:49:09 +01:00
> A Spotify mini player and notifier for Windows
2018-03-25 18:56:59 +01:00
### [Toastify](https://github.com/aleab/toastify) by [@aleab](https://github.com/aleab)
2018-03-25 18:56:59 +01:00
> Toastify adds global hotkeys and toast notifications to Spotify
>
2018-03-25 18:56:59 +01:00
> *Forked from [nachmore/toastify](https://github.com/nachmore/toastify)*
### [Spotify Oculus](https://github.com/CaptainMorgs/spotify-oculus-release) by [@CaptainMorgs](https://github.com/CaptainMorgs)
> Unity project for interacting with Spotify in virtual reality for the Oculus Rift.