Skip to content

Commit

Permalink
Prepare v1.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
clue committed Oct 24, 2017
1 parent f412389 commit 1503761
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
12 changes: 9 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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)
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -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.
Expand Down Expand Up @@ -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).
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 1503761

Please sign in to comment.