readme
This commit is contained in:
parent
f1227c2f57
commit
0348e2cc2e
1 changed files with 36 additions and 55 deletions
47
README.md
47
README.md
|
@ -1,30 +1,21 @@
|
|||
==========================================
|
||||
techrec
|
||||
==========================================
|
||||
TECHREC
|
||||
=======
|
||||
|
||||
BUG and roadmap
|
||||
See roadmap for details
|
||||
|
||||
--------
|
||||
Client
|
||||
--------
|
||||
|
||||
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
|
||||
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).
|
||||
|
||||
|
||||
Data Format
|
||||
===================================
|
||||
|
||||
--------
|
||||
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
|
||||
--------
|
||||
|
||||
JSON = {
|
||||
'starttime-rec-1385231288390': '2013/11/23 19:32:49',
|
||||
'endtime-rec-1385231288390': '2013/11/23 19:32:49',
|
||||
|
@ -33,14 +24,8 @@ JSON = {
|
|||
'op': 'new'
|
||||
}
|
||||
|
||||
--------
|
||||
Retrieve
|
||||
--------
|
||||
|
||||
|
||||
--------
|
||||
Update
|
||||
--------
|
||||
-------
|
||||
|
||||
JSON = {
|
||||
'starttime-rec-1385231288390': '2013/11/23 19:32:49',
|
||||
|
@ -50,13 +35,9 @@ JSON = {
|
|||
'op': 'update'
|
||||
}
|
||||
|
||||
--------
|
||||
Delete
|
||||
--------
|
||||
------
|
||||
JSON = {
|
||||
'recid': 'rec-1385231288390', ### VALID REC ID
|
||||
'op': 'delete'
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
|
Loading…
Reference in a new issue