From 0d821547e35ae18917829b004be569340805d0ab Mon Sep 17 00:00:00 2001 From: Ian Gulliver Date: Thu, 22 May 2014 10:38:34 -0700 Subject: [PATCH] Package overview --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2a1dac3 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +cosmopolite +=========== + +Client/server publish/subscribe and key/value storage for AppEngine. + +Components: +* A server API built on the AppEngine Python framework. +* A browser client library written in JavaScript. + +Feature overview: +* Near-realtime notification to subscribers of messages published to a "subject" +* Server-side storage of past messages for replay later to clients +* Support for associating a key with a message and for lookup of the most recent + message for a given key +* Client identification persistence via localStorage tokens or in combination + with Google account signin +* Complex messages supported via transparent JSON serialization +* Server-side strict ordering of messages +* Client-side message queueing in localStorage and resumption on restart +* Message duplication detection and elimination +* Promise support for notification of client -> server operation completion