diff --git a/CONTRIB.md b/CONTRIB.md new file mode 100644 index 0000000..a09b700 --- /dev/null +++ b/CONTRIB.md @@ -0,0 +1,26 @@ +# Contributing + +* Feature requests welcomed (log an issue) +* Bug reports welcomed (log an issue) +* Pull requests welcomed + +## Publishing + +Push the Version number in `SpotifyApi.NetCore.csproj` + +```xml +1.1.2 +``` + +Commit and push + + git commit -a -m "Packing v1.1.2" + git push + +Pack + + dotnet pack src/SpotifyApi.NetCore + +Publish + + dotnet nuget push .\src\SpotifyApi.NetCore\bin\Debug\SpotifyApi.NetCore.1.1.2.nupkg -k (api-key) -s https://api.nuget.org/v3/index.json diff --git a/README.md b/README.md index 3b06206..c0b1e19 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ Lightweight .NET Core wrapper for the Spotify Web API. ## Features * Targets .NET Standard 2.0 -* Opinionated * `async` by default * BYO `HttpClient` * Multi-user auth support @@ -15,7 +14,7 @@ Lightweight .NET Core wrapper for the Spotify Web API. > dotnet add package SpotifyApi.NetCore -## Usage +## Basic usage Set Environment variables: @@ -41,7 +40,15 @@ string firstTrackName = result.Tracks[0].Name; Trace.WriteLine($"First recommendation = {firstTrackName}"); ``` -See tests for more usage examples. +See tests and samples for more usage examples. + +## In this repo + +| Path | Remarks | +| ---- | ------- | +| `src/SpotifyApi.NetCore` | SpotifyApi.NetCore project | +| `src/SpotifyApi.NetCore.Tests` | Tests | +| `src/samples/SpotifyVue` | Sample project using ASP.NET Core + Vue.js | ## Spotify Web API Coverage @@ -53,64 +60,11 @@ See tests for more usage examples. | Follow | 7 | 0 | 0% | | Library | 8 | 0 | 0% | | Personalization | 1 | 0 | 0% | -| Player | 13 | 1 | 8% | +| Player | 13 | 2 | 15% | | Playlists | 12 | 1.5 | 13% | | Search | 1 | 0 | 0% | | Tracks | 5 | 0 | 0% | | Users Profile | 2 | 0 | 0% | -| **Total** | **63** | **4** | **6%** | - -Pull requests and feature requests welcomed! - -## Publishing - -Push the Version number in `SpotifyApi.NetCore.csproj` - -```xml -1.1.2 -``` - -Commit and push - - git commit -a -m "Packing v1.1.2" - git push - -Pack - - dotnet pack src/SpotifyApi.NetCore - -Publish - - dotnet nuget push .\src\SpotifyApi.NetCore\bin\Debug\SpotifyApi.NetCore.1.1.2.nupkg -k (api-key) -s https://api.nuget.org/v3/index.json - -## Links - -### Spotify - -Auth guide - -### .NET Core - -Concurrent Dictionary - -### HttpClient factory - - - -### Configuration in .NET Core - -Setting up .NET Core Configuration Providers: - -Easy Configuration Binding in ASP.NET Core: - -Configuration in ASP.NET Core: - -### Nuget - -Create and publish a Nuget package: - -Nuget package versioning: - -Nuget metadata properties: +| **Total** | **63** | **5** | **8%** | - \ No newline at end of file +Feature requests welcomed! (log an issue) diff --git a/docs/links.md b/docs/links.md index 71b0865..8ab0e0c 100644 --- a/docs/links.md +++ b/docs/links.md @@ -1,5 +1,34 @@ # Links +### Spotify + +Auth guide + +### .NET Core + +Concurrent Dictionary + +### HttpClient factory + + + +### Configuration in .NET Core + +Setting up .NET Core Configuration Providers: + +Easy Configuration Binding in ASP.NET Core: + +Configuration in ASP.NET Core: + +### Nuget + +Create and publish a Nuget package: + +Nuget package versioning: + +Nuget metadata properties: + + ## Blazor `HttpClientJsonExtensions` diff --git a/src/SpotifyApi.NetCore/SpotifyApi.NetCore.csproj b/src/SpotifyApi.NetCore/SpotifyApi.NetCore.csproj index f796daa..9aceb60 100644 --- a/src/SpotifyApi.NetCore/SpotifyApi.NetCore.csproj +++ b/src/SpotifyApi.NetCore/SpotifyApi.NetCore.csproj @@ -4,13 +4,13 @@ SpotifyApi.NetCore Spotify Web API .NET Core Lightweight .NET Core client wrapper for the Spotify Web API - 1.1.1 + 2.0.0 Daniel Larsen - Feather and Scale + Ringobot Copyright 2018 Daniel Larsen - https://github.com/FeatherAndScale/SpotifyApi.NetCore/blob/master/LICENSE - https://github.com/FeatherAndScale/SpotifyApi.NetCore - https://github.com/FeatherAndScale/SpotifyApi.NetCore + https://github.com/Ringobot/SpotifyApi.NetCore/blob/master/LICENSE + https://github.com/Ringobot/SpotifyApi.NetCore + https://github.com/Ringobot/SpotifyApi.NetCore spotify;.net core;dotnet core;api;client;wrapper