Skip to content

Renamed index.md to README.md #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 28, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.markdown → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion doc/activity.md
Original file line number Diff line number Diff line change
@@ -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/).
Expand Down
2 changes: 1 addition & 1 deletion doc/authorizations.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion doc/commits.md
Original file line number Diff line number Diff line change
@@ -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/).
Expand Down
2 changes: 1 addition & 1 deletion doc/customize.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion doc/enterprise.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion doc/gists.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion doc/issue/comments.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion doc/issue/labels.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion doc/issues.md
Original file line number Diff line number Diff line change
@@ -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/).
Expand Down
2 changes: 1 addition & 1 deletion doc/meta.md
Original file line number Diff line number Diff line change
@@ -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/).
Expand Down
2 changes: 1 addition & 1 deletion doc/notification.md
Original file line number Diff line number Diff line change
@@ -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/).
Expand Down
2 changes: 1 addition & 1 deletion doc/organization.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion doc/organization/members.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion doc/organization/teams.md
Original file line number Diff line number Diff line change
@@ -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/).

Expand Down
2 changes: 1 addition & 1 deletion doc/pull_request/comments.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/pull_requests.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion doc/repo/assets.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion doc/repo/contents.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion doc/repo/releases.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion doc/repos.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/request_any_route.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion doc/result_pager.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Result Pager
[Back to the navigation](index.md)
[Back to the navigation](README.md)

### Usage examples

Expand Down
2 changes: 1 addition & 1 deletion doc/search.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/security.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/two_factor_authentication.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Two factor authentication
[Back to the navigation](index.md)
[Back to the navigation](README.md)


### Raising the exception
Expand Down
2 changes: 1 addition & 1 deletion doc/users.md
Original file line number Diff line number Diff line change
@@ -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/).
Expand Down