Skip to content

Commit d0e2856

Browse files
committed
Update readme
1 parent 7c500a0 commit d0e2856

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@
33
<img alt="Logo" height="100" src="https://github.com/explodinglabs/refresh.js/blob/main/.images/logo-dark.png?raw=true#gh-dark-mode-only" />
44
</p>
55

6-
_Refresh.js_ lets you **refresh the browser** with an http request.
6+
_Refresh.js_ lets you **refresh browser(s) by sending an HTTP request**.
7+
8+
## How it works
9+
10+
1. The webpage connects to SSEHub and listens for events.
11+
2. You send a `POST` request to SSEHub.
12+
3. SSEHub emits the request as a Server-Sent Event.
13+
4. The webpage receives the event and refreshes itself.
714

815
<p align="center">
916
<img alt="Architecture diagram" src="https://github.com/explodinglabs/refresh.js/blob/main/.images/architecture-light.svg?raw=true#gh-light-mode-only" />
@@ -12,7 +19,9 @@ _Refresh.js_ lets you **refresh the browser** with an http request.
1219

1320
## Installation
1421

15-
Bring up the `refresh.js` container (this is just
22+
### Start the container
23+
24+
Bring up the refresh.js container (this is just
1625
[SSEHub](https://github.com/vgno/ssehub) with a little configuration):
1726

1827
```sh

0 commit comments

Comments
 (0)