--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/README.txt	Thu Jun 02 16:02:23 2016 +0200
@@ -0,0 +1,13 @@
+.. contents::
+
+
+Introduction
+============
+
+pyams_notify_ws is a Pyramid/PyAMS WebSockets server package used to handle users notifications.
+
+Clients can connect to a given WebSockets service and subscribe to notifications; these notifications can be
+general or limited to a given context.
+
+The WebSockets server doesn't have any "intelligence": it only references clients (including their roles) and
+their subscriptions, and acts as a proxy between an application server and it's clients.