From e30831da4115c22ec9702c2a35763c2d6077cc54 Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Mon, 15 Jan 2018 17:00:15 +0100
Subject: [PATCH] Documentation of the API

---
 README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..92c83fb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+Automate Android API
+====================
+
+## Installation
+
+```
+$ git clone https://gitnet.fr/deblan/android-automate-api.git
+$ cd android-automate-api
+$ make
+$ cp propel-dist.yaml propel.yaml # Edit propel.yaml
+$ make propel
+```
+
+## API
+
+### HTTP Response status
+
+* `200`: Resource found
+* `201`: Resource created
+* `204`: Resource removed
+* `404`: Resource not found
+* `500`: Internal error
+
+When a resource is created or deleted, the response will be like:
+
+```
+{
+    "status": true|false,
+    "code": 200|201|204|404|500,
+    "message": "A message"
+}
+```
+
+
+#### Create a SMS
+
+`POST /api/sms/create` with MIME media type `application/json`
+
+*Body*
+```
+{"sender": "+33611223344", "message": "Hello, World!", "time": "1516031177"}
+```
+
+#### Delete a SMS
+
+`DELETE /api/sms/delete/{id}`
+
+#### Get all SMS
+
+`GET /api/sms/list`
+
+The response contains an collection of SMS: 
+
+```
+[
+    {
+        "id": 1234,
+        "sender": "+33611223344",
+        "message": "Hello, World!",
+        "received_at": 1516031177,
+        "notified_at": 1516031179
+    },
+    ...
+]
+```