Documentation in Readme is missing some important info

nxtbgthng / OAuth2Client

Client library for OAuth2 (currently built against draft 10 of the OAuth2 spec)

855 stars 217 forks source link

Documentation in Readme is missing some important info #14

Open chbeer opened 13 years ago

chbeer commented 13 years ago

Hey Guys,

the Readme is rather helpful, but:

it doesn't describe the "User-agent flow" completely. It doesn't describe that you need to call openRedirectURL: after opening a WebView with authorizationURLWithRedirectURL: as URL
it doesn't describe the NXOAuth2Connection in a whole. The documentation says it's used like a normal NSURLConnection but it's more than that: Parameters, providing NSData, blocks, etc.

Thanks a lot for the helpful API and best regards,

Christian

paulyhedral commented 12 years ago

I spent several hours unsuccessfully trying to get this library to work until I found this issue. Please integrate these changes in the doc!! So important!

derfarg commented 11 years ago

i'm frustrated in trying to set user-agent.

Any howto?

https://github.com/37signals/bcx-api/

stigi commented 11 years ago

@derfarg don't be frustrated!

Setting the user-agent is something different than then user agent flow of oauth2.

What you want to do can be achieved like this:

NXOAuth2Account *myAccount; // once you got your account
myAccount.oauthClient.userAgent = @"myAwesomeApp 0.1/Gecko trololo";

You get the idea?

Supertecnoboff commented 11 years ago

@stigi Seriously man this documentation is so poor and its a shame because the API is so good! Could you make an example app which uses your OAuth2Client API because I have been trying to implement it with the Instagram API and all the happens now is that the app crashes because it can't get a token. And I think it can't get a token because the user needs to login via a webview first before Instagram grants a token... Please help...