Skip to content

Commit e6a77ee

Browse files
committed
Prepare v0.2.2 release
1 parent f642b6b commit e6a77ee

File tree

3 files changed

+39
-12
lines changed

3 files changed

+39
-12
lines changed

CHANGELOG.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
11
# Changelog
22

3+
## 0.2.2 (2020-04-20)
4+
5+
* Feature: Add dedicated `Compressor` and `Decompressor` classes, deprecate `ZlibFilterStream`.
6+
(#21 by @clue)
7+
8+
```php
9+
// old
10+
$compressor = Clue\React\Zlib\ZlibFilterStream::createGzipCompressor();
11+
12+
// new
13+
$compressor = new Clue\React\Zlib\Compressor(ZLIB_ENCODING_GZIP);
14+
```
15+
16+
* Feature / Bug: Work around compressing empty stream on PHP 7+.
17+
(#22 by @clue)
18+
19+
* Add compression and decompression benchmarks.
20+
(#24 by @clue)
21+
22+
* Add support / sponsorship info.
23+
(#20 by @clue)
24+
25+
* Improve test suite by running tests on PHP 7.4 and simplify test matrix
26+
and run tests on Windows.
27+
(#19 and #23 by @clue)
28+
329
## 0.2.1 (2018-05-11)
430

531
* Feature / Fix: Add backpressure support and support `pause()`/`resume()`.

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
# clue/reactphp-zlib [![Build Status](https://travis-ci.org/clue/reactphp-zlib.svg?branch=master)](https://travis-ci.org/clue/reactphp-zlib)
22

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

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

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

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

249247
```bash
250-
$ composer require clue/zlib-react:^0.2.1
248+
$ composer require clue/zlib-react:^0.2.2
251249
```
252250

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

281279
## License
282280

283-
MIT
281+
This project is released under the permissive [MIT license](LICENSE).
282+
283+
> Did you know that I offer custom development services and issuing invoices for
284+
sponsorships of releases and for contributions? Contact me (@clue) for details.
284285

285286
## More
286287

287288
* If you want to learn more about processing streams of data, refer to the documentation of
288289
the underlying [react/stream](https://github.com/reactphp/stream) component
289290
* If you want to process compressed tarballs (`.tar.gz` and `.tgz` file extension), you may
290-
want to use [clue/tar-react](https://github.com/clue/php-tar-react) on the decompressed stream.
291+
want to use [clue/reactphp-tar](https://github.com/clue/reactphp-tar) on the decompressed stream.

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
22
"name": "clue/zlib-react",
3-
"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).",
3+
"description": "Streaming zlib compressor and decompressor for ReactPHP, supporting compression and decompression of GZIP, ZLIB and raw DEFLATE formats.",
44
"keywords": ["zlib", "gzip", "gz", "deflate", "inflate", "compression", "decompression", "RFC 1950", "RFC 1951", "RFC 1952", "ReactPHP"],
55
"homepage": "https://github.com/clue/reactphp-zlib",
66
"license": "MIT",
77
"authors": [
88
{
99
"name": "Christian Lück",
10-
"email": "christian@lueck.tv"
10+
"email": "christian@clue.engineering"
1111
}
1212
],
1313
"require": {

0 commit comments

Comments
 (0)