[Checkins] SVN: z3c.resourceinclude/trunk/ Added description and instructions on pushing a layer onto the request.

[Malthe Borch]

Log message for revision 84411:
  Added description and instructions on pushing a layer onto the request.

Changed:
  U   z3c.resourceinclude/trunk/README.txt
  U   z3c.resourceinclude/trunk/setup.py

-=-
Modified: z3c.resourceinclude/trunk/README.txt
===================================================================
--- z3c.resourceinclude/trunk/README.txt	2008-03-02 17:58:47 UTC (rev 84410)
+++ z3c.resourceinclude/trunk/README.txt	2008-03-02 18:03:51 UTC (rev 84411)
@@ -1,8 +1,6 @@
 Overview
 --------
 
-A package that provides functionality to register resources for
-inclusion in HTML documents:
 
 * Cascading stylesheets (.css)
 * Kinetic stylesheets (.kss)
@@ -37,10 +35,14 @@
 ``IDefaultBrowserLayer`` the resource named 'example.css' will be
 included on the page.
 
-To actually include resources, a content provider is provided, see
-``z3c/resourceinclude/provide.py``.
+To render HTML snippets that include applicable resources, a content
+provider is provided, see ``z3c/resourceinclude/provide.py``.
 
+A convenience method is provided to require a given resource layer:
 
+   >>> from z3c.resourceinclude import provide
+   >>> provide(IMyLayer)
+
 Ordering
 --------
 

Modified: z3c.resourceinclude/trunk/setup.py
===================================================================
--- z3c.resourceinclude/trunk/setup.py	2008-03-02 17:58:47 UTC (rev 84410)
+++ z3c.resourceinclude/trunk/setup.py	2008-03-02 18:03:51 UTC (rev 84411)
@@ -5,7 +5,7 @@
 
 setup(name='z3c.resourceinclude',
       version=version,
-      description="",
+      description="Machinery to include web resources based on request layer.",
       long_description=open('README.txt').read(),
       classifiers=[
         "Framework :: Zope2",