From 60208b29db0a75933b2f3cf613d9214fcd5090ad Mon Sep 17 00:00:00 2001 From: Luna Mendes Date: Wed, 11 Jul 2018 18:32:42 -0300 Subject: [PATCH] docs/streaming: proof-read from @slcx ty <3 --- docs/streaming.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/streaming.md b/docs/streaming.md index be8e411..38c71b5 100644 --- a/docs/streaming.md +++ b/docs/streaming.md @@ -3,10 +3,8 @@ Elstat's Streaming API enables clients to receive realtime updates from the server. -Clients can subscribe just to *certain* channels in the case -they don't want to have a lot of overhead, or they can just -not use the Streaming API at all. It is optional. - +Clients can optionally subscribe to certain channels using the +Streaming API if they don't want to have a lot of overhead. ## Common payload format @@ -19,8 +17,8 @@ Payloads are JSON encoded. } ``` -Extra fields are on each OP's description, instead of being in -some `d` field (like Discord's Gateway API). +Data in packets are stored in specific fields, which are described +for each OP below. They are not stored inside of a `d` object, like Discord's gateway. ## Error codes @@ -63,8 +61,8 @@ some `d` field (like Discord's Gateway API). ## Channel names -Channels are what clients subscribe to receive data about that channel. -Channels are specified as `:` +Clients subscribe to channels to receive specific data. Channel names +are formatted like: `:` e.g `status:elixire` and `graph:elixire`