Skip to content

Commit 11e049f

Browse files
committed
Prepare v1.0.0 release
1 parent eef9c95 commit 11e049f

File tree

2 files changed

+27
-6
lines changed

2 files changed

+27
-6
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
## 1.0.0 (2022-04-11)
4+
5+
* First stable release, now following SemVer! 🎉
6+
Thanks to all the supporters and contributors who helped shape the project!
7+
8+
## 0.0.0 (2019-04-11)
9+
10+
* Initial import

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@ Instant real-time updates. Lightweight EventSource client receiving live
77
messages via HTML5 Server-Sent Events (SSE). Fast stream processing built on top
88
of [ReactPHP](https://reactphp.org/)'s event-driven architecture.
99

10-
> Note: This project is in early alpha stage! Feel free to report any issues you encounter.
11-
1210
**Table of contents**
1311

12+
* [Support us](#support-us)
1413
* [Quickstart example](#quickstart-example)
1514
* [Usage](#usage)
1615
* [EventSource](#eventsource)
@@ -29,6 +28,16 @@ of [ReactPHP](https://reactphp.org/)'s event-driven architecture.
2928
* [License](#license)
3029
* [More](#more)
3130

31+
## Support us
32+
33+
We invest a lot of time developing, maintaining and updating our awesome
34+
open-source projects. You can help us sustain this high-quality of our work by
35+
[becoming a sponsor on GitHub](https://github.com/sponsors/clue). Sponsors get
36+
numerous benefits in return, see our [sponsoring page](https://github.com/sponsors/clue)
37+
for details.
38+
39+
Let's take these projects to the next level together! 🚀
40+
3241
## Quickstart example
3342

3443
Once [installed](#install), you can use the following code to stream messages
@@ -43,7 +52,7 @@ data: {"name":"Carol","message":"Nice to see you Alice!"}
4352
4453
data: {"name":"Alice","message":"What a lovely chat!"}
4554
46-
data: {"name":"Bob","message":"Yeah, all powered by ReactPHP, such an awesome piece of technology :)"}
55+
data: {"name":"Bob","message":"All powered by ReactPHP, such an awesome piece of technology :)"}
4756
```
4857

4958
```php
@@ -305,13 +314,15 @@ the `$type` property will default to `message`.
305314
The recommended way to install this library is [through Composer](https://getcomposer.org/).
306315
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
307316

308-
Once released, this project will follow [SemVer](https://semver.org/).
309-
At the moment, this will install the latest development version:
317+
This project follows [SemVer](https://semver.org/).
318+
This will install the latest supported version:
310319

311320
```bash
312-
$ composer require clue/reactphp-eventsource:^1@dev
321+
$ composer require clue/reactphp-eventsource:^1
313322
```
314323

324+
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
325+
315326
This project aims to run on any platform and thus does not require any PHP
316327
extensions and supports running on legacy PHP 5.4 through current PHP 8+.
317328
It's *highly recommended to use the latest supported PHP version* for this project.

0 commit comments

Comments
 (0)