Skip to content

Commit 4d8a411

Browse files
committed
Merge remote-tracking branch 'joomla/master' into 2.0-dev
# Conflicts: # .gitignore
2 parents 32f3528 + f79ba42 commit 4d8a411

3 files changed

Lines changed: 18 additions & 14 deletions

File tree

.gitattributes

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
.github/ export-ignore
2+
build/ export-ignore
3+
Tests/ export-ignore
4+
.drone.jsonnet export-ignore
5+
.drone.yml export-ignore
16
.gitattributes export-ignore
27
.gitignore export-ignore
3-
.gitmodules export-ignore
4-
.travis/ export-ignore
5-
.travis.yml export-ignore
8+
phpunit.xml.dist export-ignore
9+
ruleset.xml export-ignore

.gitignore

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,5 @@ vendor/
22
composer.phar
33
composer.lock
44
phpunit.xml
5-
.phpunit.result.cache
6-
7-
# Build files
8-
/build/coverage
9-
/build/logs
5+
build/
6+
/.phpunit.result.cache

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
## Using the Github Package
44

55
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/.]
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

98
Github is built upon the Http package which provides an easy way to consume URLs and web services in a transport
109
independent 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

2624
Sometimes it is necessary to specify additional options. This can be done by injecting in a Registry object with your
2725
preferred 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
3229
use Joomla\Github\Github;
@@ -766,3 +763,9 @@ Alternatively, you can simply run the following from the command line:
766763
```sh
767764
composer 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

Comments
 (0)