Update documentation readme style

ciaranj · Apr 24, 2012 · 21bee6b · 21bee6b
1 parent 80d6909
commit 21bee6b
Showing 1 changed file with 55 additions and 22 deletions.
diff --git a/Readme.md b/Readme.md
@@ -4,33 +4,66 @@ A simple oauth API for node.js .  This API allows users to authenticate against
 
 Tested against Twitter (http://twitter.com), term.ie (http://term.ie/oauth/example/), TwitPic, and Yahoo!
 
-Also provides rudimentary OAuth2 support, tested against facebook connect and github.   For more complete usage examples please take a look at connect-auth (http://github.com/ciaranj/connect-auth)
+Also provides rudimentary OAuth2 support, tested against facebook, github, foursquare, google and Janrain.   For more complete usage examples please take a look at connect-auth (http://github.com/ciaranj/connect-auth)
 
 
 Change History
 ============== 
 
-* 0.10.0 - OAuth2: Pass back any extra response data for calls to getOAuthAccessToken (Thanks to Tang Bo Hao)  OAuth2: Don't force a https request if given a http url (Thanks to Damien Mathieu) OAuth2: Supports specifying a grant_type of 'refresh_token' (Thanks to Luke Baker)
-* 0.9.6 - Support for 302 redirects on OAuth2 (Thanks Patrick Negri). Some code tidying. ( Thanks to Raoul Millais )  
-* 0.9.5 - Allow usage of HTTP verbs other than GET for retrieving the access and request tokens (OAuth1) (Thanks to Raoul Millais)  
-* 0.9.4 - Support for OAuth providers that drop connections (don't send response lengths? [Google]) And change OAuth2 getOAuthAccessToken to POST rather than GET ( Possible Breaking change!!! ... re-tested against Google, Github, Facebook, FourSquare and Janrain and seems ok .. is closer to the spec (v20) )  
-* 0.9.3 - Adds support for following 301 redirects (Thanks bdickason) 
-* 0.9.2 - Correct content length calculated for non-ascii post bodies (Thanks selead)  
-Allowed for configuration of the 'access token' name used when requesting protected resources (OAuth2)  
-* 0.9.1 - Added support for automatically following 302 redirects (Thanks neyric) Added support for OAuth Echo (Thanks Ryan LeFevre). Improved handling of 2xx responses (Thanks Neil Mansilla).  
-* 0.9.0 - Compatibility fixes to bring node-oauth up to speed with node.js 0.4x [thanks to Rasmus Andersson for starting the work ]  
-* 0.8.4 - Fixed issue #14 (Parameter ordering ignored encodings).  Added support for repeated parameter names. Implements issue #15 (Use native SHA1 if available, 10x speed improvement!). Fixed issue #16 (Should use POST when requesting access tokens.).  Fixed Issue #17 (OAuth2 spec compliance).  Implemented enhancement #13 (Adds support for PUT & DELETE http verbs). Fixes issue #18 (Complex/Composite url arguments [thanks novemberborn])  
-* 0.8.3 - Fixed an issue where the auth header code depended on the Array's toString method (Yohei Sasaki) Updated the getOAuthRequestToken method so we can access google's OAuth secured methods. Also re-implemented and fleshed out the test suite.  
-* 0.8.2 - The request returning methods will now write the POST body if provided (Chris Anderson), the code responsible for manipulating the headers is a bit safe now when working with other code (Paul McKellar) and tweaked the package.json to use index.js instead of main.js  
-* 0.8.1 - Added mechanism to get hold of a signed Node Request object, ready for attaching response listeners etc. (Perfect for streaming APIs)  
-* 0.8.0 - Standardised method capitalisation, the old getOauthAccessToken is now getOAuthAccessToken (Breaking change to existing code)  
-* 0.7.7 - Looks like non oauth_ parameters where appearing within the Authorization headers, which I believe to be incorrect.  
-* 0.7.6 - Added in oauth_verifier property to getAccessToken required for 1.0A  
-* 0.7.5 - Added in a main.js to simplify the require'ing of OAuth  
-* 0.7.4 - Minor change to add an error listener to the OAuth client (thanks troyk)  
-* 0.7.3 - OAuth 2 now sends a Content-Length Http header to keep nginx happy :)  
-* 0.7.2 - Fixes some broken unit tests!  
-* 0.7.0 - Introduces support for HTTPS end points and callback URLS for OAuth 1.0A and Oauth 2 (Please be aware that this was a breaking change to the constructor arguments order)  
+* 0.9.7
+    - OAuth2:   Pass back any extra response data for calls to getOAuthAccessToken (Thanks to Tang Bo Hao)
+    - OAuth2:   Don't force a https request if given a http url (Thanks to Damien Mathieu)
+    - OAuth2:   Supports specifying a grant-type of 'refresh-token' (Thanks to Luke Baker)
+* 0.9.6
+    - OAuth2:   Support for 302 redirects (Thanks Patrick Negri). 
+    - OAuth1/2: Some code tidying. ( Thanks to Raoul Millais )  
+* 0.9.5
+    - OAuth1:   Allow usage of HTTP verbs other than GET for retrieving the access and request tokens (Thanks to Raoul Millais)  
+* 0.9.4
+    - OAuth1/2: Support for OAuth providers that drop connections (don't send response lengths? [Google]) 
+    - OAuth2:   Change getOAuthAccessToken to POST rather than GET ( Possible Breaking change!!! ... re-tested against Google, Github, Facebook, FourSquare and Janrain and seems ok .. is closer to the spec (v20) )  
+* 0.9.3
+    - OAuth1:   Adds support for following 301 redirects (Thanks bdickason) 
+* 0.9.2 
+    - OAuth1:   Correct content length calculated for non-ascii post bodies (Thanks selead)  
+    - OAuth1:   Allowed for configuration of the 'access token' name used when requesting protected resources (OAuth2)  
+* 0.9.1
+    - OAuth1:   Added support for automatically following 302 redirects (Thanks neyric) 
+    - OAuth1:   Added support for OAuth Echo (Thanks Ryan LeFevre). 
+    - OAuth1:   Improved handling of 2xx responses (Thanks Neil Mansilla).  
+* 0.9.0
+    - OAuth1/2: Compatibility fixes to bring node-oauth up to speed with node.js 0.4x [thanks to Rasmus Andersson for starting the work ]  
+* 0.8.4
+    - OAuth1:   Fixed issue #14 (Parameter ordering ignored encodings).
+    - OAuth1:   Added support for repeated parameter names.
+    - OAuth1/2: Implements issue #15 (Use native SHA1 if available, 10x speed improvement!).
+    - OAuth2:   Fixed issue #16 (Should use POST when requesting access tokens.).
+    - OAuth2:   Fixed Issue #17 (OAuth2 spec compliance).  
+    - OAuth1:   Implemented enhancement #13 (Adds support for PUT & DELETE http verbs). 
+    - OAuth1:   Fixes issue #18 (Complex/Composite url arguments [thanks novemberborn])  
+* 0.8.3
+    - OAuth1:   Fixed an issue where the auth header code depended on the Array's toString method (Yohei Sasaki) Updated the getOAuthRequestToken method so we can access google's OAuth secured methods. Also re-implemented and fleshed out the test suite.  
+* 0.8.2
+    - OAuth1:   The request returning methods will now write the POST body if provided (Chris Anderson), the code responsible for manipulating the headers is a bit safe now when working with other code (Paul McKellar)
+    - Package:  Tweaked the package.json to use index.js instead of main.js  
+* 0.8.1
+    - OAuth1:   Added mechanism to get hold of a signed Node Request object, ready for attaching response listeners etc. (Perfect for streaming APIs)  
+* 0.8.0
+    - OAuth1:   Standardised method capitalisation, the old getOauthAccessToken is now getOAuthAccessToken (Breaking change to existing code)  
+* 0.7.7
+    - OAuth1:   Looks like non oauth_ parameters where appearing within the Authorization headers, which I believe to be incorrect.  
+* 0.7.6
+    - OAuth1:   Added in oauth_verifier property to getAccessToken required for 1.0A  
+* 0.7.5
+    - Package:  Added in a main.js to simplify the require'ing of OAuth  
+* 0.7.4
+    - OAuth1:   Minor change to add an error listener to the OAuth client (thanks troyk)  
+* 0.7.3
+    - OAuth2:   Now sends a Content-Length Http header to keep nginx happy :)  
+* 0.7.2
+    - OAuth1:   Fixes some broken unit tests!  
+* 0.7.0
+    - OAuth1/2: Introduces support for HTTPS end points and callback URLS for OAuth 1.0A and Oauth 2 (Please be aware that this was a breaking change to the constructor arguments order)  
 
 Contributors
 ============