cbax/simpleshout
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
cbax 2024-09-24 18:38:37 +00:00
parent 5da40ac2d8
commit d36a2582df
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -15,7 +15,9 @@ A small chat box API for use on public websites.
## API ## API
- init: takes a username returns `init_scrollback` previous messages, a sync rate, and a client identifier, or an error if username exists/is not allowed - init: takes a cookie, returns a session if exits, else requests new session.
- channels: returns a list of channels and a preview message for each
- join: takes a username and channel, returns `init_scrollback` previous messages, a sync rate, and a client identifier, or an error if username exists/is not allowed, or channel does not exist
- sync: takes a client identifier and returns all unseen messages - sync: takes a client identifier and returns all unseen messages
- send: sends a message, returns a status - send: sends a message, returns a status
- login: accepts password, gives client admin perms if password is correct - login: accepts password, gives client admin perms if password is correct