Skip to content

Commit dbc1d15

Browse files
committed
Improve documentation, reference ReactPHP and Framework X
1 parent 96a9e33 commit dbc1d15

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
[![CI status](https://github.com/clue/reactphp-eventsource/actions/workflows/ci.yml/badge.svg)](https://github.com/clue/reactphp-eventsource/actions)
44
[![installs on Packagist](https://img.shields.io/packagist/dt/clue/reactphp-eventsource?color=blue&label=installs%20on%20Packagist)](https://packagist.org/packages/clue/reactphp-eventsource)
55

6-
Event-driven EventSource client, receiving streaming messages from any HTML5 Server-Sent Events (SSE) server,
7-
built on top of [ReactPHP](https://reactphp.org/).
6+
Instant real-time updates. Lightweight EventSource client receiving live
7+
messages via HTML5 Server-Sent Events (SSE). Fast stream processing built on top
8+
of [ReactPHP](https://reactphp.org/)'s event-driven architecture.
89

910
> Note: This project is in early alpha stage! Feel free to report any issues you encounter.
1011
@@ -26,6 +27,7 @@ built on top of [ReactPHP](https://reactphp.org/).
2627
* [Install](#install)
2728
* [Tests](#tests)
2829
* [License](#license)
30+
* [More](#more)
2931

3032
## Quickstart example
3133

@@ -335,3 +337,12 @@ This project is released under the permissive [MIT license](LICENSE).
335337

336338
> Did you know that I offer custom development services and issuing invoices for
337339
sponsorships of releases and for contributions? Contact me (@clue) for details.
340+
341+
## More
342+
343+
* If you want to learn more about processing streams of data, refer to the documentation of
344+
the underlying [react/stream](https://github.com/reactphp/stream) component.
345+
346+
* If you're looking to run the server side of your Server-Sent Events (SSE)
347+
application, you may want to use the powerful server implementation provided
348+
by [Framework X](https://framework-x.org/).

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "clue/reactphp-eventsource",
3-
"description": "Event-driven EventSource client, receiving streaming messages from any HTML5 Server-Sent Events (SSE) server, built on top of ReactPHP",
3+
"description": "Instant real-time updates. Lightweight EventSource client receiving live messages via HTML5 Server-Sent Events (SSE). Fast stream processing built on top of ReactPHP's event-driven architecture.",
44
"keywords": ["EventSource", "Server-Side Events", "SSE", "event-driven", "ReactPHP", "async"],
55
"homepage": "https://github.com/clue/reactphp-eventsource",
66
"license": "MIT",

0 commit comments

Comments
 (0)