From 99b197d7a2c96096a4a12065a0e9bd5ad4e01d09 Mon Sep 17 00:00:00 2001
From: gempir <gempir.dev@gmail.com>
Date: Wed, 26 Apr 2017 19:45:59 +0200
Subject: [PATCH] start of api docs

---
 README.MD | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 65 insertions(+), 2 deletions(-)

diff --git a/README.MD b/README.MD
index 5926a4e..12fa6be 100644
--- a/README.MD
+++ b/README.MD
@@ -4,5 +4,68 @@
 gempbot is a bot I maintain for a couple of channels. It's features differ from other bots in that it doesn't support
 commands etc. yet, it focuses on logging and providing an api for the logs.
 
-#### Usage
-You need glide to install the dependencies and you should study the config.json.example if you want to run your own bot
\ No newline at end of file
+##API
+**Root Domain** `https://api.gempir.com`
+
+##### All Requests only with HTTPS!
+
+
+#### RandomQuote
+
+Responds with a random message from the give user in that channel.
+
+
+* **URL** `/channel/%channel%/user/%username%/random`
+
+* **Methods** `GET` 
+
+* **Parameter**
+  -  `%channel%` Channel from which you want the quote
+  - `%username%` Username from whom you want the quote
+
+* **Success Response**
+
+  * **Code:** 200 
+    **Content:** `gempir: My Random Message`
+ 
+* **Error Response:** `{"Error":"error finding logs"}`
+
+- **Notice**
+
+  With the Header Content-Type: "application/json" the response will be in json format. Example:
+`{
+  "channel": "gempbot",
+  "username": "gempir",
+  "message": "MingLee",
+  "timestamp": "2017-03-12 09:43:22"
+}`
+
+#### Userlog
+
+Responds with the timestamped log of a user in the current month for the given channel.
+
+
+* **URL** `/channel/%channel%/user/%username%`
+
+* **Methods** `GET` 
+
+* **Parameter**
+  -  `%channel%` Channel that the user wrote in
+  - `%username%` Username that typed in the chat
+
+* **Success Response**
+
+  * **Code:** 200 
+    **Content:**
+
+[2017-04-1 06:40:24] gempir: HaHaa
+
+[2017-04-1 06:40:36] gempir: KKona
+
+[2017-04-1 06:40:43] gempir: NaM
+
+ 
+* **Error Response:** `{"message":"Not Found"}`
+* **Notice**
+
+  This endpoint will redirect to the current Month and Year so the url will say `/channel/%channel%/user/%username%/2017/April`