[Checkins] SVN: grokcore.security/trunk/ Improved documentation

[Philipp von Weitershausen]

Log message for revision 89315:
  Improved documentation
  

Changed:
  U   grokcore.security/trunk/CHANGES.txt
  U   grokcore.security/trunk/README.txt

-=-
Modified: grokcore.security/trunk/CHANGES.txt
===================================================================
--- grokcore.security/trunk/CHANGES.txt	2008-08-03 19:38:49 UTC (rev 89314)
+++ grokcore.security/trunk/CHANGES.txt	2008-08-03 20:07:08 UTC (rev 89315)
@@ -4,7 +4,7 @@
 1.1 (unreleased)
 ----------------
 
-* ...
+* Improved documentation.
 
 1.0 (2008-08-03)
 ----------------

Modified: grokcore.security/trunk/README.txt
===================================================================
--- grokcore.security/trunk/README.txt	2008-08-03 19:38:49 UTC (rev 89314)
+++ grokcore.security/trunk/README.txt	2008-08-03 20:07:08 UTC (rev 89315)
@@ -97,5 +97,30 @@
 that allow you to specify permissions for simple attribute access
 (read and write).
 
+
+API overview
+============
+
+``Permission``
+    Base class for defining permissions.  Use the ``name`` directive
+    to define the mandatory permission ID.  Optionally use the
+    ``title`` and ``description`` directives to give the permission
+    human-readable information.
+
+``Public``
+    Special permission that can be referred to whenever a component
+    should not be protected by a permission at all (public access).
+
+``require(permission_class_or_id)``
+    declares that the use of a particular component (when used as a
+    class-level directive) or a method (when used as a method
+    decorator) requires a certain permission.  The argument can either
+    be a permission class (subclass of ``Permission``) or a permission
+    ID.
+
+In addition, the ``grokcore.security`` package exposes the
+`grokcore.component`_ API.
+
+
 .. _grokcore.component: http://pypi.python.org/pypi/grokcore.component
 .. _grokcore.view: http://pypi.python.org/pypi/grokcore.view