add readme

This commit is contained in:
Blake DeMarcy 2017-04-02 23:53:08 -05:00
parent fb013773c3
commit ed0036aa71
1 changed files with 19 additions and 0 deletions

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# AAAAAAAAAAAAAAAAAAAAA
Hi. This will be BBJs final form. The prototype and its elisp client
are available in the *prototype* folder.
Not all endpoints are fully operational or implemented. Database
logic is not final. Documentation is not fully available and ideas
are not completely fleshed out. While the prototype is currently more
operational, it lacks features and has severe structural issues that
are now being addressed.
The biggest changes from the prototype are:
* moved from stdlib `socketserver` to a cherrypy http server
* more consistent response and data objects
* a real database (sqlite3)
* better internal exception handling
There are more. I will write about them later.