Skip to content

Commit 1503761

Browse files
committed
Prepare v1.0.0 release
1 parent f412389 commit 1503761

3 files changed

Lines changed: 19 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# Changelog
22

3-
## v0.1.2 (2017-10-18)
3+
## 1.0.0 (2017-10-24)
4+
5+
* First stable release, now following SemVer
6+
7+
> Contains no other changes, so it's actually fully compatible with the v0.1.2 release.
8+
9+
## 0.1.2 (2017-10-18)
410

511
* Feature: Optional maximum buffer length for `buffer()` (#3 by @WyriHaximus)
612
* Improvement: Readme improvements (#5 by @jsor)
713

8-
## v0.1.1 (2017-05-15)
14+
## 0.1.1 (2017-05-15)
915

1016
* Improvement: Forward compatibility with stream 1.0, 0.7, 0.6, and 0.5 (#2 by @WyriHaximus)
1117

12-
## v0.1.0 (2017-05-10)
18+
## 0.1.0 (2017-05-10)
1319

1420
* Initial release, adapted from [`clue/promise-stream-react`](https://github.com/clue/php-promise-stream-react)

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
[![Build Status](https://travis-ci.org/reactphp/promise-stream.svg?branch=master)](https://travis-ci.org/reactphp/promise-stream)
44

5-
The missing link between Promise-land and Stream-land,
6-
built on top of [ReactPHP](https://reactphp.org/).
5+
The missing link between Promise-land and Stream-land
6+
for [ReactPHP](https://reactphp.org/).
77

88
**Table of Contents**
99

@@ -16,8 +16,6 @@ built on top of [ReactPHP](https://reactphp.org/).
1616
* [Install](#install)
1717
* [License](#license)
1818

19-
> Note: This project is in beta stage! Feel free to report any issues you encounter.
20-
2119
## Usage
2220

2321
This lightweight library consists only of a few simple functions.
@@ -218,14 +216,20 @@ the `error` event.
218216
The recommended way to install this library is [through Composer](https://getcomposer.org).
219217
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
220218

219+
This project follows [SemVer](http://semver.org/).
221220
This will install the latest supported version:
222221

223222
```bash
224-
$ composer require react/promise-stream
223+
$ composer require react/promise-stream:^1.0
225224
```
226225

227226
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
228227

228+
This project aims to run on any platform and thus does not require any PHP
229+
extensions and supports running on legacy PHP 5.3 through current PHP 7+ and
230+
HHVM.
231+
It's *highly recommended to use PHP 7+* for this project.
232+
229233
## License
230234

231235
MIT, see [LICENSE file](LICENSE).

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react/promise-stream",
3-
"description": "The missing link between Promise-land and Stream-land for React PHP",
3+
"description": "The missing link between Promise-land and Stream-land for ReactPHP",
44
"keywords": ["unwrap", "stream", "buffer", "promise", "ReactPHP", "async"],
55
"homepage": "https://github.com/reactphp/promise-stream",
66
"license": "MIT",

0 commit comments

Comments
 (0)