From 0348e2cc2e45569484648866f6a439f3f3c98142 Mon Sep 17 00:00:00 2001
From: boyska <piuttosto@logorroici.org>
Date: Tue, 26 Nov 2013 14:31:18 +0100
Subject: [PATCH] readme

---
 README.md | 91 ++++++++++++++++++++++---------------------------------
 1 file changed, 36 insertions(+), 55 deletions(-)

diff --git a/README.md b/README.md
index a17bc28..cb2d2fa 100644
--- a/README.md
+++ b/README.md
@@ -1,62 +1,43 @@
-==========================================
-    techrec
-==========================================
+TECHREC
+=======
 
-BUG and roadmap
-See roadmap for details
+A Python2 web application that assist radio speakers in recording their shows.
+At the moment, it relies on some details that are specific of our radio (like
+the directory/format of the continous recording).
 
---------
- Client
+
+
+Implementation details
+======================
+
+It is based on bottle, to get a minimal framework. Rest APIs are offered
+through it, and the static site uses them.
+
+Create
 --------
 
-The Client is a JS script that exchange data with server via JSON
-
---------
- Server
---------
-
-The Server is a python software and uses the bottle library to implements a web 
-services 
-
-
-Data Format
-===================================
-
---------
- Create 
---------
-JSON = {
-        'starttime-rec-1385231288390': '2013/11/23 19:32:49', 
-        'endtime-rec-1385231288390': '2013/11/23 19:32:49', 
-        'recid': 'rec-1385231288390', 
-        'name-rec-1385231288390': 'adasd',
-        'op': 'new'
-        }
-
---------
-Retrieve
---------
-
-
---------
- Update
--------- 
-
-JSON = {
-        'starttime-rec-1385231288390': '2013/11/23 19:32:49', 
-        'endtime-rec-1385231288390': '2013/11/23 19:32:49', 
-        'recid': 'rec-1385231288390', ### VALID REC ID 
-        'name-rec-1385231288390': 'adasd',
-        'op': 'update'
-        }
-        
---------
- Delete
---------
-JSON = {
-        'recid': 'rec-1385231288390', ### VALID REC ID 
-        'op': 'delete'
-        }
+    JSON = {
+            'starttime-rec-1385231288390': '2013/11/23 19:32:49',
+            'endtime-rec-1385231288390': '2013/11/23 19:32:49',
+            'recid': 'rec-1385231288390',
+            'name-rec-1385231288390': 'adasd',
+            'op': 'new'
+            }
 
+Update
+-------
 
+    JSON = {
+            'starttime-rec-1385231288390': '2013/11/23 19:32:49',
+            'endtime-rec-1385231288390': '2013/11/23 19:32:49',
+            'recid': 'rec-1385231288390', ### VALID REC ID
+            'name-rec-1385231288390': 'adasd',
+            'op': 'update'
+            }
 
+Delete
+------
+    JSON = {
+            'recid': 'rec-1385231288390', ### VALID REC ID
+            'op': 'delete'
+            }