1- # The Github Package [ ![ Build Status] ( https://ci.joomla.org/api/badges/joomla-framework/github-api/status.svg?ref=refs/heads/2.0-dev )] ( https://ci.joomla.org/joomla-framework/github-api )
1+ # The GitHub Package [ ![ Build Status] ( https://ci.joomla.org/api/badges/joomla-framework/github-api/status.svg?ref=refs/heads/2.0-dev )] ( https://ci.joomla.org/joomla-framework/github-api )
22
3- ## Using the Github Package
3+ [ ![ Latest Stable Version] ( https://poser.pugx.org/joomla/github/v/stable )] ( https://packagist.org/packages/joomla/github )
4+ [ ![ Total Downloads] ( https://poser.pugx.org/joomla/github/downloads )] ( https://packagist.org/packages/joomla/github )
5+ [ ![ Latest Unstable Version] ( https://poser.pugx.org/joomla/github/v/unstable )] ( https://packagist.org/packages/joomla/github )
6+ [ ![ License] ( https://poser.pugx.org/joomla/github/license )] ( https://packagist.org/packages/joomla/github )
47
5- The Github package is designed to be a straightforward interface for working with Github. It is based on version 3 of
6- the Github API. You can find documentation on the API at [ http://developer.github.com/v3/ ] ( http://developer.github.com/v3/ ) .
8+ ## Using the GitHub Package
79
8- Github is built upon the Http package which provides an easy way to consume URLs and web services in a transport
10+ The GitHub package is designed to be a straightforward interface for working with GitHub. It is based on version 3 of
11+ the GitHub API. You can find documentation on the API at [ http://developer.github.com/v3/ ] ( http://developer.github.com/v3/ ) .
12+
13+ GitHub is built upon the Http package which provides an easy way to consume URLs and web services in a transport
914independent way. ` Joomla\Http ` currently supports streams, sockets and cURL. It is possible to create a custom
10- context and inject it into the Github class if one so desires.
15+ context and inject it into the GitHub class if one so desires.
1116
12- ### Instantiating Github
17+ ### Instantiating GitHub
1318
14- Instantiating Github is easy:
19+ Instantiating GitHub is easy:
1520
1621``` php
1722use Joomla\Github\Github;
1823
1924$github = new Github;
2025```
2126
22- This creates a basic Github object that can be used to access publicly available resources on [ github.com] ( https://github.com ) .
27+ This creates a basic GitHub object that can be used to access publicly available resources on [ github.com] ( https://github.com ) .
2328
2429Sometimes it is necessary to specify additional options. This can be done by injecting in a Registry object with your
25- preferred options. Support is available for optionally providing a custom Github account username and password,
26- as well as a custom URL for the Github server (as would be the case for using a local instance of [ Github Enterprise] ( https://enterprise.github.com ) ).
30+ preferred options. Support is available for optionally providing a custom GitHub account username and password,
31+ as well as a custom URL for the GitHub server (as would be the case for using a local instance of [ GitHub Enterprise] ( https://enterprise.github.com ) ).
2732
2833``` php
2934use Joomla\Github\Github;
@@ -39,7 +44,7 @@ $github = new Github($options);
3944
4045A ` gh.token ` option is also available.
4146
42- Here is an example demonstrating more of the Github package:
47+ Here is an example demonstrating more of the GitHub package:
4348
4449``` php
4550use Joomla\Github\Github;
@@ -67,13 +72,13 @@ $summary = implode("\n", $issueSummary);
6772$github->gists->create(array('issue_summary.txt' => $summary));
6873```
6974
70- ## Accessing the Github APIs
75+ ## Accessing the GitHub APIs
7176
72- The Github object using magic methods to access sub-packages of the Github server's API that can be accessed using
77+ The GitHub object using magic methods to access sub-packages of the GitHub server's API that can be accessed using
7378the ` -> ` object operator.
7479
7580Where a result is returned by a PHP method, the result is the PHP equivalent of the JSON response that can be found in
76- the Github API documentation.
81+ the GitHub API documentation.
7782
7883### Activity
7984
@@ -743,7 +748,7 @@ $github->pulls->comments->delete(':owner', ':repo', ':commentId');
743748## See Also
744749
745750The following resources contain more information: [ Joomla! API Reference] ( http://api.joomla.org ) ,
746- [ Github API Reference] ( http://developer.github.com ) .
751+ [ GitHub API Reference] ( http://developer.github.com ) .
747752
748753
749754## Installation via Composer
0 commit comments