Merge pull request #247 from mnapoli/patch-1

pilot · pilot · commit a49b7db34c18 · 2015-02-28T23:18:18.000+02:00
Renamed index.md to README.md
diff --git a/README.md b/README.md
@@ -90,7 +90,7 @@ Using cache, the client will get cached responses if resources haven't changed s
 
 ## Documentation
 
-See the `doc` directory for more detailed documentation.
+See the [`doc` directory](doc/) for more detailed documentation.
 
 ## License
 
diff --git a/doc/README.md b/doc/README.md
diff --git a/doc/activity.md b/doc/activity.md
@@ -1,5 +1,5 @@
 ## Activity API (incomplete)
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Access to Starring and Watching a Repository for [non] authenticated users.
 Wrap [GitHub Activity API](https://developer.github.com/v3/activity/).
diff --git a/doc/authorizations.md b/doc/authorizations.md
@@ -1,5 +1,5 @@
 ## Authorizations API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Creating, deleting and listing authorizations. Wraps [GitHub Authorizations API](http://developer.github.com/v3/oauth/).
 
diff --git a/doc/commits.md b/doc/commits.md
@@ -1,5 +1,5 @@
 ## Commits API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Getting information on specific commits, the diffs they introduce, the files they've changed.
 Wrap [GitHub Commit API](http://developer.github.com/v3/git/commits/).
diff --git a/doc/customize.md b/doc/customize.md
@@ -1,5 +1,5 @@
 ## Customize `php-github-api` and testing
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 ### Configure the http client
 
diff --git a/doc/enterprise.md b/doc/enterprise.md
@@ -1,5 +1,5 @@
 ## Enterprise API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Provides information about a GitHub Enterprise installation. Wraps [GitHub Enterprise API](http://developer.github.com/v3/enterprise/).
 
diff --git a/doc/gists.md b/doc/gists.md
@@ -1,5 +1,5 @@
 ## Gists API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Creating, editing, deleting and listing gists. Wraps [GitHub Gists API](http://developer.github.com/v3/gists/).
 
diff --git a/doc/issue/comments.md b/doc/issue/comments.md
@@ -1,5 +1,5 @@
 ## Issues / Comments API
-[Back to the "Issues API"](../issues.md) | [Back to the navigation](../index.md)
+[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md)
 
 Wraps [GitHub Issue Comments API](http://developer.github.com/v3/issues/comments/).
 
diff --git a/doc/issue/labels.md b/doc/issue/labels.md
@@ -1,5 +1,5 @@
 ## Issues / Labels API
-[Back to the "Issues API"](../issues.md) | [Back to the navigation](../index.md)
+[Back to the "Issues API"](../issues.md) | [Back to the navigation](../README.md)
 
 Wraps [GitHub Issue Labels API](http://developer.github.com/v3/issues/labels/).
 
diff --git a/doc/issues.md b/doc/issues.md
@@ -1,5 +1,5 @@
 ## Issues API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Listing issues, searching, editing and closing your projects issues.
 Wraps [GitHub Issue API](http://developer.github.com/v3/issues/).
diff --git a/doc/meta.md b/doc/meta.md
@@ -1,5 +1,5 @@
 ## Users API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 
 Wrap [GitHub User API](http://developer.github.com/v3/meta/).
diff --git a/doc/notification.md b/doc/notification.md
@@ -1,5 +1,5 @@
 ## Notification API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Listing notifications and marking them as read.
 Wraps [GitHub Notification API](https://developer.github.com/v3/activity/notifications/).
diff --git a/doc/organization.md b/doc/organization.md
@@ -1,5 +1,5 @@
 ## Organization API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Wraps [GitHub Organization API](http://developer.github.com/v3/organization/).
 
diff --git a/doc/organization/members.md b/doc/organization/members.md
@@ -1,5 +1,5 @@
 ## Organization / Members API
-[Back to the "Organization API"](../organization.md) | [Back to the navigation](../index.md)
+[Back to the "Organization API"](../organization.md) | [Back to the navigation](../README.md)
 
 Wraps [GitHub Organization Members API](http://developer.github.com/v3/organization/members/).
 
diff --git a/doc/organization/teams.md b/doc/organization/teams.md
@@ -1,5 +1,5 @@
 ## Organization / Teams API
-[Back to the "Organization API"](../organization.md) | [Back to the navigation](../index.md)
+[Back to the "Organization API"](../organization.md) | [Back to the navigation](../README.md)
 
 Wraps [GitHub Organization Teams API](http://developer.github.com/v3/organization/teams/).
 
diff --git a/doc/pull_request/comments.md b/doc/pull_request/comments.md
@@ -1,5 +1,5 @@
 ## Pull Requests / Review Comments API
-[Back to the "Pull Requests API"](../pull_requests.md) | [Back to the navigation](../index.md)
+[Back to the "Pull Requests API"](../pull_requests.md) | [Back to the navigation](../README.md)
 
 Review Comments are comments on a portion of the unified diff. These are separate from Commit Comments (which
 are applied directly to a commit, outside of the Pull Request view), and Issue Comments (which do not reference
diff --git a/doc/pull_requests.md b/doc/pull_requests.md
@@ -1,5 +1,5 @@
 ## Pull Requests API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Additional APIs:
 * [Review Comments](pull_request/comments.md)
diff --git a/doc/repo/assets.md b/doc/repo/assets.md
@@ -1,5 +1,5 @@
 ## Repo / Releases API
-[Back to the "Repos API"](../repos.md) | [Back to the navigation](../index.md)
+[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
 
 ### List all assets by release
 
diff --git a/doc/repo/contents.md b/doc/repo/contents.md
@@ -1,5 +1,5 @@
 ## Repo / Contents API
-[Back to the "Repos API"](../repos.md) | [Back to the navigation](../index.md)
+[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
 
 ### Get a repository's README
 
diff --git a/doc/repo/releases.md b/doc/repo/releases.md
@@ -1,5 +1,5 @@
 ## Repo / Releases API
-[Back to the "Repos API"](../repos.md) | [Back to the navigation](../index.md)
+[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
 
 This Github API Endpoint is currently undocumented because it's new, but works just fine.
 
diff --git a/doc/repos.md b/doc/repos.md
@@ -1,5 +1,5 @@
 ## Repositories API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Searching repositories, getting repository information and managing repository information for authenticated users.
 Wrap [GitHub Repo API](http://developer.github.com/v3/repos/). All methods are described on that page.
diff --git a/doc/request_any_route.md b/doc/request_any_route.md
@@ -1,5 +1,5 @@
 ## Request any Route
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 The method you need does not exist yet? You can access any GitHub route by using the "get" and "post" methods.
 For example:
diff --git a/doc/result_pager.md b/doc/result_pager.md
@@ -1,5 +1,5 @@
 ## Result Pager
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 ### Usage examples
 
diff --git a/doc/search.md b/doc/search.md
@@ -1,5 +1,5 @@
 ## Search API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Searching repositories, code, issues and users.
 Wrap [GitHub Search API](http://developer.github.com/v3/search/). All methods are described on that page.
diff --git a/doc/security.md b/doc/security.md
@@ -1,5 +1,5 @@
 ## Authentication & Security
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Most GitHub services do not require authentication, but some do. For example the methods that allow you to change
 properties on Repositories and some others. Therefore this step is facultative.
diff --git a/doc/two_factor_authentication.md b/doc/two_factor_authentication.md
@@ -1,5 +1,5 @@
 ## Two factor authentication
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 
 ### Raising the exception
diff --git a/doc/users.md b/doc/users.md
@@ -1,5 +1,5 @@
 ## Users API
-[Back to the navigation](index.md)
+[Back to the navigation](README.md)
 
 Searching users, getting user information and managing authenticated user account information.
 Wrap [GitHub User API](http://developer.github.com/v3/users/).
