diff --git a/README.md b/README.md index 7463922..cba6eb7 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,12 @@ This is a c# wrapper around the Untappd API. This can be downloaded via [Nuget]( ## API Coverage -So far only the Requests that do not require user tokens have been implemented +Current both Authenticated and Unauthenticated requests. +More info: https://untappd.com/api/docs +For Authenticated requests, you should already have a valid token, provided via OAuth authentication. +Such authentication can be achieved using Owin OAuth Providers for ASP.NET Web Applications, which already have an Untappd provider. +More info: https://github.com/RockstarLabs/OwinOAuthProviders ## How do I use? @@ -28,9 +32,16 @@ var ts = new UnAuthenticatedUntappdCredentials("key", "secret"); var t = new Repository().Get(ts, "tparnell"); var t = new Repository().Get(ts, "BeerIdHere"); - ``` +For Authenticated requests: + +```csharp + +var ts = new AuthenticatedUntappdCredentials("token", "key", "secret"); +var t = new Repository().Get(ts); + +``` ## Contributing @@ -39,3 +50,6 @@ var t = new Repository().Get(ts, "BeerIdHere"); * There are no special instructions, submit pull requests against the master branch. * Releases to nuget occur on successful release branch builds. * The only reason I do not publish on master, is because sometimes commits can just contain readme files, or unit tests changes that do not affect the nuget package + +Current contributors: +* Rodrigo P Reis (https://github.com/rodkings) \ No newline at end of file diff --git a/README.md.bak b/README.md.bak new file mode 100644 index 0000000..9c49687 --- /dev/null +++ b/README.md.bak @@ -0,0 +1,55 @@ +**Master:** [![Build status](https://ci.appveyor.com/api/projects/status/e21297waldfrso3p/branch/master?svg=true)](https://ci.appveyor.com/project/tparnell8/untappd-net/branch/master) +**Release:**[![Build status](https://ci.appveyor.com/api/projects/status/e21297waldfrso3p/branch/Release?svg=true)](https://ci.appveyor.com/project/tparnell8/untappd-net/branch/Release) +**Code Coverage:** [![Coverage Status](https://coveralls.io/repos/tparnell8/Untappd.Net/badge.svg?branch=master)](https://coveralls.io/r/tparnell8/Untappd.Net?branch=master) + +**Kanban** [![Stories in Ready](https://badge.waffle.io/tparnell8/untappd.net.png?label=ready&title=Ready)](https://waffle.io/tparnell8/untappd.net) + +**Tips:** [![Shameless tip badge tips](https://img.shields.io/gratipay/TommyParnell.svg)](https://gratipay.com/TommyParnell) +**Chat:** [![Join the chat at https://gitter.im/tparnell8/Untappd.Net](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/tparnell8/Untappd.Net?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +# Untappd.Net + +This is a c# wrapper around the Untappd API. This can be downloaded via [Nuget](https://www.nuget.org/packages/Untappd.Net/), or the [backup feed](https://www.myget.org/F/untappd-net/api/v2). + +## API Coverage + +Current both Authenticated and Unauthenticated requests. +More info: https://untappd.com/api/docs + +For Authenticated requests, you should already have a valid token, provided via OAuth authentication. +Such authentication can be achieved using Owin OAuth Providers, which alreayd exists an Untappd provider. +More info: https://github.com/RockstarLabs/OwinOAuthProviders + +## How do I use? + +* Request an [API Key](https://untappd.com/api/register?register=new) +* You should be able to make a repository and call the get method with the thing you are requesting. + +Note: Additional parameters can be passed into the Get Method with an IDictionary. + +```csharp + +var ts = new UnAuthenticatedUntappdCredentials("key", "secret"); +var t = new Repository().Get(ts, "tparnell"); +var t = new Repository().Get(ts, "BeerIdHere"); + +``` + +For Authenticated requests: + +```csharp + +var ts = new AuthenticatedUntappdCredentials("token", "key", "secret"); +var t = new Repository().Get(ts); + +``` + +## Contributing + +* Everyone is welcome to contribute! +* If you are looking for something to do, look at the issues. +* There are no special instructions, submit pull requests against the master branch. +* Releases to nuget occur on successful release branch builds. + * The only reason I do not publish on master, is because sometimes commits can just contain readme files, or unit tests changes that do not affect the nuget package + +Current contributors: +* Rodrigo P Reis (https://github.com/rodkings) \ No newline at end of file