Update README.md
This commit is contained in:
parent
7119930b6c
commit
a0be7cb059
1 changed files with 34 additions and 1 deletions
35
README.md
35
README.md
|
@ -11,4 +11,37 @@ A small chat box API for use on public websites.
|
||||||
- Message sanitization
|
- Message sanitization
|
||||||
- Keyword filtering
|
- Keyword filtering
|
||||||
- Responsive web UI
|
- Responsive web UI
|
||||||
- Embed/iframe-able
|
- Embed/iframe-able
|
||||||
|
|
||||||
|
## 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
|
||||||
|
- sync: takes a client identifier and returns all unseen messages
|
||||||
|
- send: sends a message, returns a status
|
||||||
|
- login: accepts password, gives client admin perms if password is correct
|
||||||
|
- delete: takes an admin client identifier and a message id
|
||||||
|
- ban: bans a client
|
||||||
|
|
||||||
|
## Structs
|
||||||
|
|
||||||
|
- config
|
||||||
|
- admin_password
|
||||||
|
- ratelimit (req/min)
|
||||||
|
- \[banned_words\]
|
||||||
|
- \[banned_usernames\]
|
||||||
|
- \[banned_ips\]
|
||||||
|
- init_scrollback
|
||||||
|
- sync_rate
|
||||||
|
|
||||||
|
- message
|
||||||
|
- client_id
|
||||||
|
- timestamp
|
||||||
|
- body
|
||||||
|
|
||||||
|
- client
|
||||||
|
- client_id
|
||||||
|
- username
|
||||||
|
- ip_address
|
||||||
|
- admin_perms
|
||||||
|
- banned
|
||||||
|
- ratelimit
|
Loading…
Reference in a new issue