update readme

zopefoundation · Jan 15, 2009 · 5e1cd35 · 5e1cd35
1 parent ebe0725
commit 5e1cd35
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/zope/globalrequest/README.txt b/src/zope/globalrequest/README.txt
@@ -5,12 +5,19 @@ Introduction
 ------------
 
 This package provides a global way to retrieve the currently active request
-object in a zope-based web framework.
+object in a zope-based web framework.  To do so you simply need to do the
+following::
+
+  from zope.globalrequest import getRequest
+  request = getRequest()
 
 
 Functional Tests
 ----------------
 
+The remainder of this file contains functional tests to demonstrate that the
+package works as intended.
+
 First we make sure our test view works:
 
   >>> from zope.testbrowser.testing import Browser