Skip to content

Commit

Permalink
Prepare v0.2.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
clue committed Aug 19, 2017
1 parent fbb90cb commit 1e7e07f
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 5 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Changelog

## 0.2.0 (2017-08-19)

* Feature / BC break: Update to Stream v0.6 API and forward compatibility with Stream v1.0
(#13 and #15 by @clue)

* Fix: Remove event listeners once closed
(#14 by @clue)

* Improve documentation
(#15 and #16 by @clue)

* Improve test suite by adding PHPUnit to require-dev and
Lock Travis distro so new future defaults will not break the build
(#11 and #12 by @clue)

## 0.1.0 (2015-11-12)

* First tagged release
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,13 +151,28 @@ If you feel some test case is missing or outdated, we're happy to accept PRs! :)

## Install

The recommended way to install this library is [through composer](https://getcomposer.org).
[New to composer?](https://getcomposer.org/doc/00-intro.md)
The recommended way to install this library is [through Composer](https://getcomposer.org).
[New to Composer?](https://getcomposer.org/doc/00-intro.md)

This will install the latest supported version:

```bash
$ composer require clue/zlib-react:~0.1.0
$ composer require clue/zlib-react:^0.2
```

See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.

This project aims to run on any platform and thus does not require any PHP
extensions and supports running on legacy PHP 5.3 through current PHP 7+ and
HHVM.
It's *highly recommended to use PHP 7+* for this project.
Older PHP versions may suffer from a number of inconsistencies documented above.

The `ext-zlib` extension is not required to install this library, however it
is required to actually do anything meaningful with this library.
Each of the above methods will throw an `Exception` if this extension is
missing.

## Tests

To run the test suite, you first need to clone this repo and then install all
Expand Down
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "clue/zlib-react",
"description": "Streaming zlib compressor and decompressor, supporting GZIP format (RFC 1952), raw DEFLATE format (RFC 1951) and ZLIB format (RFC 1950)",
"keywords": ["zlib", "gzip", "gz", "deflate", "inflate", "compression", "decompression", "RFC 1950", "RFC 1951", "RFC 1952", "reactphp"],
"description": "Streaming zlib compressor and decompressor for ReactPHP, supporting ZLIB format, raw DEFLATE format and GZIP format (RFC 1950, RFC 1951 and RFC 1952)",
"keywords": ["zlib", "gzip", "gz", "deflate", "inflate", "compression", "decompression", "RFC 1950", "RFC 1951", "RFC 1952", "ReactPHP"],
"homepage": "https://github.com/clue/php-zlib-react",
"license": "MIT",
"authors": [
Expand Down

0 comments on commit 1e7e07f

Please sign in to comment.