Prepare v1.0.0 release

Author: clue

CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 1.0.0 (2020-05-28)
+
+*   Feature: Change `Compressor` and `Decompressor` to use more efficient streaming compression context.
+    (#28 by @clue)
+
+    This also fixes any inconsistencies and supports proper error reporting for invalid data.
+    Benchmark results suggest this improves both compression and decompression performance by ca. 25%.
+
+*   BC break: Require PHP 7+ with `ext-zlib` during installation and drop legacy PHP and legacy HHVM support.
+    (#25, 26 and #28 by @clue)
+
+    We're committed to providing a smooth upgrade path for legacy setups.
+    If you need to support legacy PHP versions and legacy HHVM, you may want to
+    check out the legacy `v0.2.x` release branch.
+    This legacy release branch also provides an installation candidate that does not
+    require `ext-zlib` during installation but uses runtime checks instead.
+    In this case, you can install this project like this:
+
+    ```bash
+    $ composer require "clue/zlib-react:^1.0||^0.2.2"
+    ```
+
+*   BC break: Remove deprecated APIs and mark `ZlibFilterStream` as internal only.
+    (#27 by @clue)
+
+*   Improve test suite by updating PHPUnit, clean up test suite and
+    add `.gitattributes` to exclude dev files from exports.
+    (#29 by @clue)
+
 ## 0.2.2 (2020-04-20)
 
 *   Feature: Add dedicated `Compressor` and `Decompressor` classes, deprecate `ZlibFilterStream`.

README.md

@@ -3,10 +3,9 @@
 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.
-
 **Table of contents**
 
+* [Support us](#support-us)
 * [Quickstart example](#quickstart-example)
 * [Formats](#formats)
     * [GZIP format](#gzip-format)
@@ -20,6 +19,16 @@ supporting compression and decompression of GZIP, ZLIB and raw DEFLATE formats.
 * [License](#license)
 * [More](#more)
 
+## Support us
+
+We invest a lot of time developing, maintaining and updating our awesome
+open-source projects. You can help us sustain this high-quality of our work by
+[becoming a sponsor on GitHub](https://github.com/sponsors/clue). Sponsors get
+numerous benefits in return, see our [sponsoring page](https://github.com/sponsors/clue)
+for details.
+
+Let's take these projects to the next level together! 🚀
+
 ## Quickstart example
 
 Once [installed](#install), you can use the following code to pipe a readable
@@ -166,11 +175,11 @@ For more details, see ReactPHP's
 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 project follows [SemVer](https://semver.org/).
 This will install the latest supported version:
 
 ```bash
-$ composer require clue/zlib-react:^0.2.2
+$ composer require clue/zlib-react:^1.0
 ```
 
 See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
@@ -190,6 +199,11 @@ If you need to support legacy PHP versions and legacy HHVM, you may want to
 check out the legacy `v0.2.x` release branch.
 This legacy release branch also provides an installation candidate that does not
 require `ext-zlib` during installation but uses runtime checks instead.
+In this case, you can install this project like this:
+
+```bash
+$ composer require "clue/zlib-react:^1.0||^0.2.2"
+```
 
 ## Tests