Skip to content

Commit 9dfd6de

Browse files
committed
docs: update Readme to better reflect on the ping message
1 parent cea5b9b commit 9dfd6de

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,11 @@ certstream-server-go offers multiple endpoints to connect to.
4141
You can connect to the certstream-server by opening a **websocket connection** to any of the aforementioned endpoints.
4242
After you're connected, certificate information will be streamed to your websocket.
4343

44-
The server requires you to send a ping message at least every 60 seconds (it's recommended to use an interval of 30s for pings). If the server did not receive a ping message for more than this time, the server will disconnect you. The server will **not** send out ping messages to your client.
44+
The server requires you to send a **ping message** at least every 60 seconds (it's recommended to use an interval of 30s for pings).
45+
If the server did not receive a ping message for more than this time, the server will disconnect you.
46+
The server will **not** send out ping messages to your client.
47+
48+
Read more about ping/pong WebSocket messages in the [Mozilla Developer Docs](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers#pings_and_pongs_the_heartbeat_of_websockets).
4549

4650
### Example
4751
To receive a live example of any of the endpoints, just send an HTTP GET request to the endpoints with `/example.json` appended to the endpoint. So for example `/full-stream/example.json`. This example shows the lite format of a certificate update.

0 commit comments

Comments
 (0)