tweaks

Author: robbecker-wf

README.md

@@ -45,18 +45,34 @@ and then use it:
 ```dart
 import 'package:github/github.dart';
 
-void main() async {
+Future<void> main() async {
   /* Create a GitHub Client, with anonymous authentication by default */
   var github = GitHub();
 
-  /* or Create a GitHub Client and have it try to find your token or credentials automatically */
-  var github = GitHub(auth: findAuthenticationFromEnvironment());  
+  /* or Create a GitHub Client and have it try to find your token or credentials automatically
+  In Flutter and in server environments this will search environment variables in this order
+  GITHUB_ADMIN_TOKEN
+  GITHUB_DART_TOKEN
+  GITHUB_API_TOKEN
+  GITHUB_TOKEN
+  HOMEBREW_GITHUB_API_TOKEN
+  MACHINE_GITHUB_API_TOKEN
+  and then GITHUB_USERNAME and GITHUB_PASSWORD
+
+  In a browser it will search keys in the same order first through the query string parameters
+  and then in window sessionStorage
+  */
+  var github = GitHub(auth: findAuthenticationFromEnvironment());
 
   /* or Create a GitHub Client using an auth token */
-  var github = GitHub(auth: new Authentication.withToken("YourTokenHere"));  
+  var github = GitHub(auth: new Authentication.withToken("YourTokenHere"));
+
+  /* or Create a GitHub Client using a username and password */
+  var github = GitHub(auth: new Authentication.basic('username', 'password'));
 
   Repository repo = await github.repositories.getRepository(new RepositorySlug("user_or_org", "repo_name"));
   /* Do Something with repo */
+
 }
 ```
 

example/releases.dart

@@ -14,7 +14,8 @@ Future<void> main() async {
 
 void loadReleases() {
   github.repositories
-      .listReleases(RepositorySlug('twbs', 'bootstrap'))
+      .listReleases(RepositorySlug('Workiva', 'wdesk'))
+      .take(10)
       .toList()
       .then((releases) {
     for (final release in releases) {

lib/src/common/model/repos_releases.dart

@@ -11,6 +11,7 @@ part 'repos_releases.g.dart';
 class Release {
   Release({
     this.id,
+    this.url,
     this.htmlUrl,
     this.tarballUrl,
     this.uploadUrl,
@@ -28,6 +29,9 @@ class Release {
     this.assets,
   });
 
+  /// Url to this Release
+  String url;
+
   /// Url to this Release
   String htmlUrl;
 

lib/src/common/model/repos_releases.g.dart

@@ -935,14 +935,6 @@ class RepositoriesService extends Service {
     );
   }
 
-  /// Fetches a single release by the release ID.
-  ///
-  /// API docs: https://developer.github.com/v3/repos/releases/#get-a-single-release
-  @Deprecated(
-      'Use getReleaseById or for getting a release using a tag name, use getReleaseByTagName')
-  Future<Release> getRelease(RepositorySlug slug, int id) =>
-      getReleaseById(slug, id);
-
   /// Fetches a single release by the release ID.
   ///
   /// API docs: https://developer.github.com/v3/repos/releases/#get-a-single-release

lib/src/common/repos_service.dart

@@ -1,12 +1,12 @@
 # Integration Tests
 
-The integration tests will run against the live GitHub API. These tests will 
+The integration tests will run against the live GitHub API. These tests will
 verify that the library is properly coded against the actual behavior of the
 GitHub API.
 
 To run these tests a GitHub repository and OAuth token will need to be defined
-in the `config/config.dart` file. 
+in the `config/config.dart` file.
 
-**Warning:** The test will delete and recreate the specified repository to 
-start with a clean repo. It is highly recommended that a dedicated test account 
-is used!
+**Warning:** The test will delete and recreate the specified repository to
+start with a clean repo. It is highly recommended that a dedicated test account
+is used!