ashie
/
elstat
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs/streaming: proof-read from @slcx 

ty <3
This commit is contained in:
Luna Mendes 2018-07-11 18:32:42 -03:00
parent 31a0f2b989
commit 60208b29db
No known key found for this signature in database
GPG Key ID: 7D950EEE259CE92F
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/streaming.md
View File

@ -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 `<type>:<name>`
Clients subscribe to channels to receive specific data. Channel names
are formatted like: `<type>:<name>`
e.g `status:elixire` and `graph:elixire`