Skip to content

Commit 443c8b1

Browse files
committed
README made more accessible with a navigation and named internal links.
1 parent 856a330 commit 443c8b1

File tree

1 file changed

+36
-3
lines changed

1 file changed

+36
-3
lines changed

README.markdown

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,12 @@ Replace the `/path/to/lib/` path with the path you used for php-github-api insta
4545

4646
From this object, you can access to all GitHub apis, listed below.
4747

48+
<a name='nav'></a>
49+
*Navigation*: [Users][] | [Issues][] | [Commits][] | [Objects][] | [Repos][] | [Pull Requests][] | [Request any Route][] | [Authentication & Security][] | [Customize php-github-api][] | [Run Test Suite][]
50+
51+
<a name='users'></a>
4852
## Users
53+
<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
4954

5055
Searching users, getting user information and managing authenticated user account information.
5156
Wrap [GitHub User API](http://develop.github.com/p/users.html).
@@ -144,7 +149,9 @@ Returns an array of the authenticated user emails. Requires authentication.
144149

145150
Return an array of the authenticated user emails. Requires authentication.
146151

152+
<a name='issues'></a>
147153
## Issues
154+
<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
148155

149156
Listing issues, searching, editing and closing your projects issues.
150157
Wrap [GitHub Issue API](http://develop.github.com/p/issues.html).
@@ -294,7 +301,9 @@ Returns an array of commits.
294301

295302
Returns a single commit.
296303

304+
<a name='objects'></a>
297305
## Objects
306+
<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
298307

299308
Getting full versions of specific files and trees in your Git repositories. Wrap [GitHub objects API](http://develop.github.com/p/objects.html).
300309

@@ -331,7 +340,9 @@ Returns array of blob informations.
331340
The last parameter can be either a blob SHA1, a tree SHA1 or a commit SHA1.
332341
Returns the raw text content of the object.
333342

343+
<a name='repos'></a>
334344
## Repos
345+
<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
335346

336347
Searching repositories, getting repository information and managing repository information for authenticated users.
337348
Wrap [GitHub Repo API](http://develop.github.com/p/repo.html). All methods are described on that page.
@@ -547,7 +558,9 @@ To include non GitHub users, add a third parameter to true:
547558

548559

549560

550-
## Pull requests
561+
<a name='pull_requests'></a>
562+
## Pull Requests
563+
<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
551564

552565
Lets you list pull requests for a given repository, list one pull request in particular along with its discussion, and create a pull-request.
553566
Wraps [GitHub Pull Request API](http://develop.github.com/p/pulls.html), still tagged **BETA**. All methods are described there.
@@ -616,7 +629,9 @@ Requires authentication. The issue ID is provided instead of title and body.
616629
This returns the details of the pull request.
617630

618631

619-
## Request any route
632+
<a name='request_any_route'></a>
633+
## Request any Route
634+
<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
620635

621636
The method you need does not exist yet?
622637
You can access any GitHub route by using the "get" and "post" methods.
@@ -630,7 +645,9 @@ Returns an array describing the php-github-api repository.
630645

631646
See all GitHub API routes: [http://develop.github.com/](http://develop.github.com/)
632647

648+
<a name='authentication_and_security'></a>
633649
## Authentication & Security
650+
<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
634651

635652
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.
636653

@@ -665,7 +682,9 @@ If you want to stop new requests from being authenticated, you can use the deAut
665682
$github->deAuthenticate();
666683
```
667684

685+
<a name='customize'></a>
668686
## Customize php-github-api
687+
<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
669688

670689
The library is highly configurable and extensible thanks to dependency injection.
671690

@@ -724,7 +743,9 @@ For example, to replace the user API:
724743
$github->setApi('user', new MyGithubApiUser($github));
725744
```
726745

727-
## Run test suite
746+
<a name='run_test_suite'></a>
747+
## Run Test Suite
748+
<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
728749

729750
The code is unit tested. To run tests on your machine, from a CLI, run
730751

@@ -742,3 +763,15 @@ This library borrows ideas, code and tests from [phptwitterbot](http://code.goog
742763
- Thanks to [Nicolas Pastorino](http://github.com/jeanvoye) for his contribution on the Pull Request API.
743764

744765
Thanks to GitHub for the high quality API and documentation.
766+
767+
768+
[Users]: #users
769+
[Issues]: #issues
770+
[Commits]: #commits
771+
[Objects]: #objects
772+
[Repos]: #repos
773+
[Pull Requests]: #pull_requests
774+
[Request any Route]: #request_any_route
775+
[Authentication & Security]: #authentication_and_security
776+
[Customize php-github-api]: #customize
777+
[Run Test Suite]: #run_test_suite

0 commit comments

Comments
 (0)