Skip to content

README: drop outdated info, simplify install #645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
acrobat merged 2 commits into from
Nov 14, 2017
Merged

README: drop outdated info, simplify install #645

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02b6825
README: drop outdated info, simplify install
Nov 12, 2017
895e2ca
README: remove tagging
Nov 12, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 6 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
# PHP GitHub API 2.0

In 2.0 lib no longer uses guzzle 3.7, instead it has an HTTPlug abstraction layer.

For old version please check:

* [branch](https://github.com/KnpLabs/php-github-api/tree/1.7)
* [readme](https://github.com/KnpLabs/php-github-api/tree/1.7/README.md)
* [docs](https://github.com/KnpLabs/php-github-api/tree/1.7/doc)
# PHP GitHub API

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

## Features

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

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

## Install

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

```bash
$ curl -s http://getcomposer.org/installer | php
```

Then run the following command to require the library:
```bash
$ php composer.phar require knplabs/github-api php-http/guzzle6-adapter
$ composer require knplabs/github-api php-http/guzzle6-adapter
```

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).


## Using Laravel?

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

// This file is generated by Composer
require_once 'vendor/autoload.php';
require_once __DIR__ . '/vendor/autoload.php';

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

// This file is generated by Composer
require_once 'vendor/autoload.php';
require_once __DIR__ . '/vendor/autoload.php';

use Cache\Adapter\Redis\RedisCachePool;

Expand Down