diff --git a/README.md b/README.md index b1372f798c70b7307707765bbe49c048120e65af..868f852264f2ad6d2b7d4de9f47bd3b32d147151 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # QuicksyServer QuicksyServer is the backend of the [Quicksy](https://quicksy.im)-App that handles both registration of new users (verified by SMS) and phone number to Jabber ID discovery. + +## HTTP API + +The HTTP API is responsible for registration, password resets and SMS verification. As far as the app is concerned initial registration and password reset behave exactly the same. + +### `GET /authentication/$phoneNumber` + +#### Header + +#### Response Codes + +### `POST /password` + +## XMPP API