Skip to content

Commit d2e04e5

Browse files
Tomáš Votrubaacrobat
Tomáš Votruba
authored andcommitted
README: drop outdated info, simplify install (#645)
* README: drop outdated info, simplify install * README: remove tagging
1 parent ccf4ed7 commit d2e04e5

File tree

1 file changed

+6
-20
lines changed

1 file changed

+6
-20
lines changed

README.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
# PHP GitHub API 2.0
2-
3-
In 2.0 lib no longer uses guzzle 3.7, instead it has an HTTPlug abstraction layer.
4-
5-
For old version please check:
6-
7-
* [branch](https://github.com/KnpLabs/php-github-api/tree/1.7)
8-
* [readme](https://github.com/KnpLabs/php-github-api/tree/1.7/README.md)
9-
* [docs](https://github.com/KnpLabs/php-github-api/tree/1.7/doc)
1+
# PHP GitHub API
102

113
[![Build Status](https://travis-ci.org/KnpLabs/php-github-api.svg?branch=master)](https://travis-ci.org/KnpLabs/php-github-api)
124
[![StyleCI](https://styleci.io/repos/3948501/shield?style=flat)](https://styleci.io/repos/3948501)
@@ -17,7 +9,6 @@ Uses [GitHub API v3](http://developer.github.com/v3/) & supports [GitHub API v4]
179

1810
## Features
1911

20-
* Follows PSR-4 conventions and coding standard: autoload friendly
2112
* Light and fast thanks to lazy loading of API classes
2213
* Extensively tested and documented
2314

@@ -29,20 +20,15 @@ Uses [GitHub API v3](http://developer.github.com/v3/) & supports [GitHub API v4]
2920

3021
## Install
3122

32-
The new version of `php-github-api` using [Composer](http://getcomposer.org).
33-
The first step to use `php-github-api` is to download composer:
23+
Via Composer:
3424

3525
```bash
36-
$ curl -s http://getcomposer.org/installer | php
37-
```
38-
39-
Then run the following command to require the library:
40-
```bash
41-
$ php composer.phar require knplabs/github-api php-http/guzzle6-adapter
26+
$ composer require knplabs/github-api php-http/guzzle6-adapter
4227
```
4328

4429
Why `php-http/guzzle6-adapter`? We are decoupled from any HTTP messaging client with help by [HTTPlug](http://httplug.io/). Read about clients in our [docs](doc/customize.md).
4530

31+
4632
## Using Laravel?
4733

4834
[Laravel GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) by [Graham Campbell](https://github.com/GrahamCampbell) might interest you.
@@ -53,7 +39,7 @@ Why `php-http/guzzle6-adapter`? We are decoupled from any HTTP messaging client
5339
<?php
5440

5541
// This file is generated by Composer
56-
require_once 'vendor/autoload.php';
42+
require_once __DIR__ . '/vendor/autoload.php';
5743

5844
$client = new \Github\Client();
5945
$repositories = $client->api('user')->repositories('ornicar');
@@ -69,7 +55,7 @@ This example uses the PSR6 cache pool [redis-adapter](https://github.com/php-cac
6955
<?php
7056

7157
// This file is generated by Composer
72-
require_once 'vendor/autoload.php';
58+
require_once __DIR__ . '/vendor/autoload.php';
7359

7460
use Cache\Adapter\Redis\RedisCachePool;
7561

0 commit comments

Comments
 (0)