From ed0036aa71c46d19cf83c36ef81f713e5e9a5f5b Mon Sep 17 00:00:00 2001 From: Blake DeMarcy Date: Sun, 2 Apr 2017 23:53:08 -0500 Subject: [PATCH] add readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f52d0e --- /dev/null +++ b/README.md @@ -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.