|
1 | 1 | # clue/reactphp-zlib [](https://travis-ci.org/clue/reactphp-zlib) |
2 | 2 |
|
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. |
8 | 5 |
|
9 | 6 | > Note: This project is in beta stage! Feel free to report any issues you encounter. |
10 | 7 |
|
@@ -95,8 +92,8 @@ This format is commonly used in a streaming context: |
95 | 92 | * PHP: `gzcompress()` and `gzuncompress()` |
96 | 93 | * [HTTP compression](https://en.wikipedia.org/wiki/HTTP_compression) with `Content-Encoding: deflate` header |
97 | 94 | * 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) |
100 | 97 | uses the ZLIB format prefixed with the uncompressed length (as `UINT32BE`). |
101 | 98 |
|
102 | 99 | 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! :) |
244 | 241 | The recommended way to install this library is [through Composer](https://getcomposer.org). |
245 | 242 | [New to Composer?](https://getcomposer.org/doc/00-intro.md) |
246 | 243 |
|
| 244 | +While in beta, this project does not currently follow [SemVer](https://semver.org/). |
247 | 245 | This will install the latest supported version: |
248 | 246 |
|
249 | 247 | ```bash |
250 | | -$ composer require clue/zlib-react:^0.2.1 |
| 248 | +$ composer require clue/zlib-react:^0.2.2 |
251 | 249 | ``` |
252 | 250 |
|
253 | 251 | See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades. |
@@ -280,11 +278,14 @@ $ php vendor/bin/phpunit |
280 | 278 |
|
281 | 279 | ## License |
282 | 280 |
|
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. |
284 | 285 |
|
285 | 286 | ## More |
286 | 287 |
|
287 | 288 | * If you want to learn more about processing streams of data, refer to the documentation of |
288 | 289 | the underlying [react/stream](https://github.com/reactphp/stream) component |
289 | 290 | * 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. |
0 commit comments