Skip to content

Commit

Permalink
Prepare v0.2.2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
clue committed Apr 20, 2020
1 parent f642b6b commit e6a77ee
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 12 deletions.
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Changelog

## 0.2.2 (2020-04-20)

* Feature: Add dedicated `Compressor` and `Decompressor` classes, deprecate `ZlibFilterStream`.
(#21 by @clue)

```php
// old
$compressor = Clue\React\Zlib\ZlibFilterStream::createGzipCompressor();

// new
$compressor = new Clue\React\Zlib\Compressor(ZLIB_ENCODING_GZIP);
```

* Feature / Bug: Work around compressing empty stream on PHP 7+.
(#22 by @clue)

* Add compression and decompression benchmarks.
(#24 by @clue)

* Add support / sponsorship info.
(#20 by @clue)

* Improve test suite by running tests on PHP 7.4 and simplify test matrix
and run tests on Windows.
(#19 and #23 by @clue)

## 0.2.1 (2018-05-11)

* Feature / Fix: Add backpressure support and support `pause()`/`resume()`.
Expand Down
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# clue/reactphp-zlib [![Build Status](https://travis-ci.org/clue/reactphp-zlib.svg?branch=master)](https://travis-ci.org/clue/reactphp-zlib)

Streaming zlib compressor and decompressor for [ReactPHP](http://reactphp.org/),
supporting compression and decompression of ZLIB format, raw DEFLATE format and
GZIP format ([RFC 1950](https://tools.ietf.org/html/rfc1950),
[RFC 1951](https://tools.ietf.org/html/rfc1951) and
[RFC 1952](https://tools.ietf.org/html/rfc1952)).
Streaming zlib compressor and decompressor for [ReactPHP](https://reactphp.org/),
supporting compression and decompression of GZIP, ZLIB and raw DEFLATE formats.

> Note: This project is in beta stage! Feel free to report any issues you encounter.
Expand Down Expand Up @@ -95,8 +92,8 @@ This format is commonly used in a streaming context:
* PHP: `gzcompress()` and `gzuncompress()`
* [HTTP compression](https://en.wikipedia.org/wiki/HTTP_compression) with `Content-Encoding: deflate` header
* Java: `DeflaterOutputStream`
* Qt's [`qCompress()`](http://doc.qt.io/qt-4.8/qbytearray.html#qCompress)
and [`qUncompress()`](http://doc.qt.io/qt-4.8/qbytearray.html#qUncompress)
* Qt's [`qCompress()`](https://doc.qt.io/archives/qt-4.8/qbytearray.html#qCompress)
and [`qUncompress()`](https://doc.qt.io/archives/qt-4.8/qbytearray.html#qUncompress)
uses the ZLIB format prefixed with the uncompressed length (as `UINT32BE`).

Technically, this format uses [raw DEFLATE compression](#raw-deflate-format) wrapped in a ZLIB header and footer:
Expand Down Expand Up @@ -244,10 +241,11 @@ If you feel some test case is missing or outdated, we're happy to accept PRs! :)
The recommended way to install this library is [through Composer](https://getcomposer.org).
[New to Composer?](https://getcomposer.org/doc/00-intro.md)

While in beta, this project does not currently follow [SemVer](https://semver.org/).
This will install the latest supported version:

```bash
$ composer require clue/zlib-react:^0.2.1
$ composer require clue/zlib-react:^0.2.2
```

See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
Expand Down Expand Up @@ -280,11 +278,14 @@ $ php vendor/bin/phpunit

## License

MIT
This project is released under the permissive [MIT license](LICENSE).

> Did you know that I offer custom development services and issuing invoices for
sponsorships of releases and for contributions? Contact me (@clue) for details.

## More

* If you want to learn more about processing streams of data, refer to the documentation of
the underlying [react/stream](https://github.com/reactphp/stream) component
* If you want to process compressed tarballs (`.tar.gz` and `.tgz` file extension), you may
want to use [clue/tar-react](https://github.com/clue/php-tar-react) on the decompressed stream.
want to use [clue/reactphp-tar](https://github.com/clue/reactphp-tar) on the decompressed stream.
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "clue/zlib-react",
"description": "Streaming zlib compressor and decompressor for ReactPHP, supporting compression and decompression of ZLIB format, raw DEFLATE format and GZIP format (RFC 1950, RFC 1951 and RFC 1952).",
"description": "Streaming zlib compressor and decompressor for ReactPHP, supporting compression and decompression of GZIP, ZLIB and raw DEFLATE formats.",
"keywords": ["zlib", "gzip", "gz", "deflate", "inflate", "compression", "decompression", "RFC 1950", "RFC 1951", "RFC 1952", "ReactPHP"],
"homepage": "https://github.com/clue/reactphp-zlib",
"license": "MIT",
"authors": [
{
"name": "Christian Lück",
"email": "christian@lueck.tv"
"email": "christian@clue.engineering"
}
],
"require": {
Expand Down

0 comments on commit e6a77ee

Please sign in to comment.