From de42f239eb2212611c305a76ed3480d806ab49d0 Mon Sep 17 00:00:00 2001
From: Daniel Gultsch <daniel@gultsch.de>
Date: Wed, 3 Jul 2019 14:07:46 +0200
Subject: [PATCH] start to document http api

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index b1372f7..868f852 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
-- 
GitLab