Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

README made more accessible with a navigation and named internal links.

  • Loading branch information...
commit 443c8b165b4e2184fabc2b0e393407ced184d231 1 parent 856a330
Philipp Klaus authored June 20, 2011

Showing 1 changed file with 36 additions and 3 deletions. Show diff stats Hide diff stats

  1. 39  README.markdown
39  README.markdown
Source Rendered
@@ -45,7 +45,12 @@ Replace the `/path/to/lib/` path with the path you used for php-github-api insta
45 45
 
46 46
 From this object, you can access to all GitHub apis, listed below.
47 47
 
  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>
48 52
 ## Users
  53
+<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
49 54
 
50 55
 Searching users, getting user information and managing authenticated user account information.
51 56
 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.
144 149
 
145 150
 Return an array of the authenticated user emails. Requires authentication.
146 151
 
  152
+<a name='issues'></a>
147 153
 ## Issues
  154
+<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
148 155
 
149 156
 Listing issues, searching, editing and closing your projects issues.
150 157
 Wrap [GitHub Issue API](http://develop.github.com/p/issues.html).
@@ -294,7 +301,9 @@ Returns an array of commits.
294 301
 
295 302
 Returns a single commit.
296 303
 
  304
+<a name='objects'></a>
297 305
 ## Objects
  306
+<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
298 307
 
299 308
 Getting full versions of specific files and trees in your Git repositories. Wrap [GitHub objects API](http://develop.github.com/p/objects.html).
300 309
 
@@ -331,7 +340,9 @@ Returns array of blob informations.
331 340
 The last parameter can be either a blob SHA1, a tree SHA1 or a commit SHA1.
332 341
 Returns the raw text content of the object.
333 342
 
  343
+<a name='repos'></a>
334 344
 ## Repos
  345
+<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
335 346
 
336 347
 Searching repositories, getting repository information and managing repository information for authenticated users.
337 348
 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:
547 558
 
548 559
 
549 560
 
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>
551 564
 
552 565
 Lets you list pull requests for a given repository, list one pull request in particular along with its discussion, and create a pull-request. 
553 566
 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.
616 629
 This returns the details of the pull request.
617 630
 
618 631
 
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>
620 635
 
621 636
 The method you need does not exist yet?
622 637
 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.
630 645
 
631 646
 See all GitHub API routes: [http://develop.github.com/](http://develop.github.com/)
632 647
 
  648
+<a name='authentication_and_security'></a>
633 649
 ## Authentication & Security
  650
+<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
634 651
 
635 652
 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.
636 653
 
@@ -665,7 +682,9 @@ If you want to stop new requests from being authenticated, you can use the deAut
665 682
     $github->deAuthenticate();
666 683
 ```
667 684
 
  685
+<a name='customize'></a>
668 686
 ## Customize php-github-api
  687
+<a href='#nav' alt='Back to the navigation'>Go back to the Navigation</a>
669 688
 
670 689
 The library is highly configurable and extensible thanks to dependency injection.
671 690
 
@@ -724,7 +743,9 @@ For example, to replace the user API:
724 743
     $github->setApi('user', new MyGithubApiUser($github));
725 744
 ```
726 745
 
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>
728 749
 
729 750
 The code is unit tested. To run tests on your machine, from a CLI, run
730 751
 
@@ -742,3 +763,15 @@ This library borrows ideas, code and tests from [phptwitterbot](http://code.goog
742 763
 - Thanks to [Nicolas Pastorino](http://github.com/jeanvoye) for his contribution on the Pull Request API.
743 764
 
744 765
 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 notes on commit 443c8b1

Please sign in to comment.
Something went wrong with that request. Please try again.