Skip to content

Commit

Permalink
Remove php-http/message and prepare for stable release (#118)
Browse files Browse the repository at this point in the history
* Remove php-http/message and prepare for stable release

* Update Readme.md

* Minor
  • Loading branch information
Nyholm authored Aug 15, 2016
1 parent c021c8f commit cda8b94
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 10 deletions.
22 changes: 14 additions & 8 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,6 @@ Here is a list of features that might convince you to choose this LinkedIn clien

## Installation

Install the library with Composer.

```bash
composer require happyr/linkedin-api-client
```

This library does not have a dependency on Guzzle or any other library that sends HTTP requests. We use the awesome
HTTPlug to achieve the decoupling. We want you to choose what library to use for sending HTTP requests. Consult this list
ofthis list virtual packages that support [php-http/client-implementation](https://packagist.org/providers/php-http/client-implementation)
Expand All @@ -44,9 +38,22 @@ find clients to use. For more information about virtual packages please refer to
composer require php-http/guzzle6-adapter
```

You do also need to install a PSR-7 implementation and a factory to create PSR-7 messages (PSR-17 whenever that is
released). You could use Guzzles PSR-7 implementation and factories from php-http:

```bash
composer require guzzlehttp/psr7 php-http/message
```

Now you may install the library by running the following:

```bash
composer require happyr/linkedin-api-client
```

If you are updating form a previous version make sure to read [the upgrade documentation](Upgrade.md).

### Finding the HTTP client.
### Finding the HTTP client (optional)

The LinkedIn client need to know what library you are using to send HTTP messages. You could provide an instance of
HttpClient and MessageFactory or you could fallback on auto discovery. Below is an example on where you provide a Guzzle6
Expand All @@ -59,7 +66,6 @@ $linkedIn->setHttpMessageFactory(new Http\Message\MessageFactory\GuzzleMessageFa

```


## Usage

In order to use this API client (or any other LinkedIn clients) you have to [register your application][register-app]
Expand Down
6 changes: 6 additions & 0 deletions Upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

This document explains how you upgrade from one version to another.

## Upgrade from 0.7.2 to 1.0

### Changes

* We do not longer require `php-http/message`. You have to make sure to put that in your own composer.json.

## Upgrade from 0.7.1 to 0.7.2

### Changes
Expand Down
3 changes: 1 addition & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
"php": "^5.5 || ^7.0",
"php-http/client-implementation": "^1.0",
"php-http/httplug": "^1.0",
"php-http/message": "^1.0",
"php-http/message-factory": "^1.0",
"php-http/discovery": "^1.0"
},
Expand All @@ -35,7 +34,7 @@
},
"extra": {
"branch-alias": {
"dev-master": "0.8.x-dev"
"dev-master": "1.1.x-dev"
}
}
}

0 comments on commit cda8b94

Please sign in to comment.