33## Using the Github Package
44
55The 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/ .]
7- (http://developer.github.com/v3/ )
6+ the Github API. You can find documentation on the API at [ http://developer.github.com/v3/ ] ( http://developer.github.com/v3/ ) .
87
98Github is built upon the Http package which provides an easy way to consume URLs and web services in a transport
109independent way. ` Joomla\Http ` currently supports streams, sockets and cURL. It is possible to create a custom
@@ -20,13 +19,11 @@ use Joomla\Github\Github;
2019$github = new Github;
2120```
2221
23- This creates a basic Github object that can be used to access publicly available resources on [ github.com]
24- (https://github.com ).
22+ This creates a basic Github object that can be used to access publicly available resources on [ github.com] ( https://github.com ) .
2523
2624Sometimes it is necessary to specify additional options. This can be done by injecting in a Registry object with your
2725preferred options. Support is available for optionally providing a custom Github account username and password,
28- as well as a custom URL for the Github server (as would be the case for using a local instance of [ Github Enterprise]
29- (https://enterprise.github.com )).
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 ) ).
3027
3128``` php
3229use Joomla\Github\Github;
@@ -766,3 +763,9 @@ Alternatively, you can simply run the following from the command line:
766763``` sh
767764composer require joomla/github " ~1.0"
768765```
766+
767+ If you want to include the test sources, use
768+
769+ ``` sh
770+ composer require --prefer-source joomla/github " ~1.0"
771+ ```
0 commit comments