[Checkins] SVN: zc.zk/trunk/src/zc/zk/README.txt Documented ``zc.zk.ZK`` and pre-defined access control lists

[Jim Fulton]

Log message for revision 124155:
  Documented ``zc.zk.ZK`` and pre-defined access control lists
  ``zc.zk.OPEN_ACL_UNSAFE`` and ``zc.zk.READ_ACL_UNSAFE``
  

Changed:
  U   zc.zk/trunk/src/zc/zk/README.txt

-=-
Modified: zc.zk/trunk/src/zc/zk/README.txt
===================================================================
--- zc.zk/trunk/src/zc/zk/README.txt	2012-01-24 14:46:01 UTC (rev 124154)
+++ zc.zk/trunk/src/zc/zk/README.txt	2012-01-24 16:18:34 UTC (rev 124155)
@@ -978,6 +978,33 @@
 
     The ``Properties`` instance is returned.
 
+Other module attributes
+------------------------
+
+``zc.zk.ZK``
+   A convenient aliad for ``zc.zk.ZooKeeper`` for people who hate to
+   type.
+
+``zc.zk.OPEN_ACL_UNSAFE``
+   An access control list that grants the world all rights.
+
+``zc.zk.READ_ACL_UNSAFE``
+   An access control list that gives the world read access only.
+
+.. test
+
+    >>> zc.zk.ZK is zc.zk.ZooKeeper
+    True
+
+    >>> import zookeeper
+    >>> zc.zk.OPEN_ACL_UNSAFE == [
+    ...     dict(perms=zookeeper.PERM_ALL, scheme='world', id='anyone')]
+    True
+
+    >>> zc.zk.READ_ACL_UNSAFE == [
+    ...     dict(perms=zookeeper.PERM_READ, scheme='world', id='anyone')]
+    True
+
 Testing support
 ---------------
 
@@ -1002,6 +1029,11 @@
 - ``delete_recursive`` now has a ``force`` argument to force deletion of
   ephemeral nodes.
 
+- Added ``zc.zk.ZK`` as an alias for ``zc.zk.ZooKeeper``.
+
+- Documented pre-defined access control lists
+  ``zc.zk.OPEN_ACL_UNSAFE`` and ``zc.zk.READ_ACL_UNSAFE``
+
 - Fixed: the ``dry_run`` argument to ``delete_recursive`` didn't work
   properly.