Add more info to readme

pull/5/head
~erin 2021-07-16 14:33:17 -04:00
parent 839f60724d
commit 76039f65cf
Signed by: erin
GPG Key ID: DA70E064A8C70F44
1 changed files with 7 additions and 1 deletions

View File

@ -1,4 +1,10 @@
# Registration api system
# Chat Registration System
The basic backend code needed to register & login to a chat system (to be built).
Send it the unhashed username and pin, and it'll store it in the `users.json` file with the pin hashed with SHA1.
## API Documentation
`POST /api/register/<name>/<pin>` Register the username with the pin provided if it doesn't already exist
`GET /api/users/<name>` Check if the user exists