diff --git a/README.md b/README.md index da039ab..af04152 100644 --- a/README.md +++ b/README.md @@ -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//` Register the username with the pin provided if it doesn't already exist `GET /api/users/` Check if the user exists