Skip to content

Commit c28cbd4

Browse files
committed
Adjust readme
1 parent d0e2856 commit c28cbd4

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
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 browser(s) by sending an HTTP request**.
6+
<p align="center">
7+
Refresh browsers with HTTP requests**.
8+
</p>
79

810
## How it works
911

@@ -28,12 +30,16 @@ Bring up the refresh.js container (this is just
2830
docker run --detach --name refresh.js --publish 8080:8080 ghcr.io/explodinglabs/refresh.js
2931
```
3032

31-
Post an event to the channel (this is required to create the channel):
33+
### Create the channel
34+
35+
To create the `changes` channel, simply post an event to it:
3236

3337
```sh
3438
curl -v -X POST -d '{"id": 1, "event": "html", "data": null}' http://localhost:8080/changes
3539
```
3640

41+
### Add script to your webpage
42+
3743
Include refresh.js in your html (put this at the bottom, right before
3844
`</html>`):
3945

0 commit comments

Comments
 (0)