Added an example use of the OAuth2 Flow

azenla · azenla · commit 6c676e07cf76 · 2014-08-02T19:12:33.000-04:00
diff --git a/lib/src/client/oauth2.dart b/lib/src/client/oauth2.dart
@@ -2,6 +2,18 @@ part of github.client;
 
 /**
  * OAuth2 Flow Helper
+ * 
+ * **Example**:
+ * 
+ *      var flow = new OAuth2Flow("ClientID", "ClientSecret");
+ *      var authUrl = flow.createAuthorizationURL();
+ *      // Display to the User and handle the redirect URI, and also get the code.
+ *      flow.exchange(code).then((response) {
+ *        var github = new GitHub(auth: new Authentication.withToken(response.token));
+ *        // Use the GitHub Client
+ *      });
+ *      
+ *      
  */
 class OAuth2Flow {
   /**
