From 1503761d01116bf893f86b9843b3bc7a80682587 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20L=C3=BCck?= Date: Tue, 24 Oct 2017 16:35:40 +0200 Subject: [PATCH] Prepare v1.0.0 release --- CHANGELOG.md | 12 +++++++++--- README.md | 14 +++++++++----- composer.json | 2 +- 3 files changed, 19 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dc7fb4b..6a39c55 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,14 +1,20 @@ # Changelog -## v0.1.2 (2017-10-18) +## 1.0.0 (2017-10-24) + +* First stable release, now following SemVer + +> Contains no other changes, so it's actually fully compatible with the v0.1.2 release. + +## 0.1.2 (2017-10-18) * Feature: Optional maximum buffer length for `buffer()` (#3 by @WyriHaximus) * Improvement: Readme improvements (#5 by @jsor) -## v0.1.1 (2017-05-15) +## 0.1.1 (2017-05-15) * Improvement: Forward compatibility with stream 1.0, 0.7, 0.6, and 0.5 (#2 by @WyriHaximus) -## v0.1.0 (2017-05-10) +## 0.1.0 (2017-05-10) * Initial release, adapted from [`clue/promise-stream-react`](https://github.com/clue/php-promise-stream-react) diff --git a/README.md b/README.md index b2b2c71..770fc47 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ [![Build Status](https://travis-ci.org/reactphp/promise-stream.svg?branch=master)](https://travis-ci.org/reactphp/promise-stream) -The missing link between Promise-land and Stream-land, -built on top of [ReactPHP](https://reactphp.org/). +The missing link between Promise-land and Stream-land +for [ReactPHP](https://reactphp.org/). **Table of Contents** @@ -16,8 +16,6 @@ built on top of [ReactPHP](https://reactphp.org/). * [Install](#install) * [License](#license) -> Note: This project is in beta stage! Feel free to report any issues you encounter. - ## Usage This lightweight library consists only of a few simple functions. @@ -218,14 +216,20 @@ the `error` event. The recommended way to install this library is [through Composer](https://getcomposer.org). [New to Composer?](https://getcomposer.org/doc/00-intro.md) +This project follows [SemVer](http://semver.org/). This will install the latest supported version: ```bash -$ composer require react/promise-stream +$ composer require react/promise-stream:^1.0 ``` 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. + ## License MIT, see [LICENSE file](LICENSE). diff --git a/composer.json b/composer.json index b4cd106..d0d5e4e 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "react/promise-stream", - "description": "The missing link between Promise-land and Stream-land for React PHP", + "description": "The missing link between Promise-land and Stream-land for ReactPHP", "keywords": ["unwrap", "stream", "buffer", "promise", "ReactPHP", "async"], "homepage": "https://github.com/reactphp/promise-stream", "license": "MIT",