Skip to content

Commit

Permalink
Prepare release (#149)
Browse files Browse the repository at this point in the history
* Update change log

* Update readme

* Prepare release

* Remove branch alias

* Update PSR-18 dependency version

* Fix changelog

* Mention in the readme that new implementations should use PSR-18

* Make requested changes

* Update readme

* Update change log
  • Loading branch information
sagikazarmark authored and Nyholm committed Oct 31, 2018
1 parent a4652dd commit b384253
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 24 deletions.
50 changes: 36 additions & 14 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Change Log

## 2.0.0 - UNRELEASED

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).


## [Unreleased]


## [2.0.0] - 2018-10-31

This version is no BC break for consumers using HTTPlug. However, HTTP clients that
implement HTTPlug need to adjust because we add return type declarations.
Expand All @@ -9,40 +19,41 @@ implement HTTPlug need to adjust because we add return type declarations.

- Support for PSR-18 (HTTP client).

### Changed

- **BC Break:** `HttpClient::sendRequest(RequestInterface $request)` has a return type annotation. The new
signature is `HttpClient::sendRequest(RequestInterface $request): ResponseInterface`.
- **BC Break:** `RequestException::getRequest()` has a return type annotation. The new
signature is `RequestException::getRequest(): RequestInterface`.

### Removed

- PHP 5 support

### Changed

- [BC Break] `HttpClient::sendRequest(RequestInterface $request)` has a return type annotation. The new
signature is `HttpClient::sendRequest(RequestInterface $request): ResponseInterface`.
- [BC Break] `RequestException::getRequest()` has a return type annotation. The new
signature is `RequestException::getRequest(): RequestInterface`.

## 1.1.0 - 2016-08-31
## [1.1.0] - 2016-08-31

### Added

- HttpFulfilledPromise and HttpRejectedPromise which respect the HttpAsyncClient interface


## 1.0.0 - 2016-01-26
## [1.0.0] - 2016-01-26

### Removed

- Stability configuration from composer


## 1.0.0-RC1 - 2016-01-12
## [1.0.0-RC1] - 2016-01-12

### Changed

- Updated package files
- Updated promise dependency to RC1


## 1.0.0-beta - 2015-12-17
## [1.0.0-beta] - 2015-12-17

### Added

Expand All @@ -53,7 +64,7 @@ signature is `RequestException::getRequest(): RequestInterface`.
- Exception concept


## 1.0.0-alpha3 - 2015-12-13
## [1.0.0-alpha3] - 2015-12-13

### Changed

Expand All @@ -64,14 +75,14 @@ signature is `RequestException::getRequest(): RequestInterface`.
- Promise interface moved to its own repository: [php-http/promise](https://github.com/php-http/promise)


## 1.0.0-alpha2 - 2015-11-16
## [1.0.0-alpha2] - 2015-11-16

### Added

- Async client and Promise interface


## 1.0.0-alpha - 2015-10-26
## [1.0.0-alpha] - 2015-10-26

### Added

Expand All @@ -93,3 +104,14 @@ signature is `RequestException::getRequest(): RequestInterface`.
### Added

- Initial release


[Unreleased]: https://github.com/php-http/httplug/compare/v2.0.0...HEAD
[2.0.0]: https://github.com/php-http/httplug/compare/v1.1.0...HEAD
[1.1.0]: https://github.com/php-http/httplug/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/php-http/httplug/compare/v1.0.0-RC1...v1.0.0
[1.0.0-RC1]: https://github.com/php-http/httplug/compare/v1.0.0-beta...v1.0.0-RC1
[1.0.0-beta]: https://github.com/php-http/httplug/compare/v1.0.0-alpha3...v1.0.0-beta
[1.0.0-alpha3]: https://github.com/php-http/httplug/compare/v1.0.0-alpha2...v1.0.0-alpha3
[1.0.0-alpha2]: https://github.com/php-http/httplug/compare/v1.0.0-alpha...v1.0.0-alpha2
[1.0.0-alpha]: https://github.com/php-http/httplug/compare/v0.1.0...v1.0.0-alpha
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,19 @@
**HTTPlug, the HTTP client abstraction for PHP.**


## Intro

HTTPlug is the predecessor of [PSR-18](http://www.php-fig.org/psr/psr-18/)
HTTP Client standard built on [PSR-7](http://www.php-fig.org/psr/psr-7/) HTTP messages.
Since there is an entire ecosystem built around HTTPlug which is already widely adopted,
we will keep maintaining this package for the time being,
but new implementations and consumers should use the PSR-18 interfaces.
HTTPlug 2.x extends the PSR-18 interfaces to allow a convenient migration path.
In the long term, we expect PSR-18 to completely replace the need for HTTPlug.

This library is the official successor of the [ivory http adapter](https://github.com/egeloen/ivory-http-adapter).


## Install

Via Composer
Expand All @@ -22,14 +35,6 @@ $ composer require php-http/httplug
```


## Intro

This is the contract package for HTTP Client.
Use it to create HTTP Clients which are interoperable and compatible with [PSR-7](http://www.php-fig.org/psr/psr-7/).

This library is the official successor of the [ivory http adapter](https://github.com/egeloen/ivory-http-adapter).


## Documentation

Please see the [official documentation](http://docs.php-http.org).
Expand Down
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"require": {
"php": "^7.0",
"psr/http-message": "^1.0",
"psr/http-client": "^0.3",
"psr/http-client": "^1.0",
"php-http/promise": "^1.0"
},
"require-dev": {
Expand All @@ -35,7 +35,7 @@
},
"extra": {
"branch-alias": {
"dev-2.x": "2.0.x-dev"
"dev-master": "2.0.x-dev"
}
}
}

0 comments on commit b384253

Please sign in to comment.