[Checkins] SVN: z3c.evalexception/trunk/README.txt Document new post-mortem pdb middleware

[Philipp von Weitershausen]

Log message for revision 79159:
  Document new post-mortem pdb middleware
  

Changed:
  U   z3c.evalexception/trunk/README.txt

-=-
Modified: z3c.evalexception/trunk/README.txt
===================================================================
--- z3c.evalexception/trunk/README.txt	2007-08-23 18:26:50 UTC (rev 79158)
+++ z3c.evalexception/trunk/README.txt	2007-08-23 18:27:15 UTC (rev 79159)
@@ -1,21 +1,58 @@
-``paste.evalexception`` lets you interactively debug exceptions in
-your WSGI app.  ``z3c.evalexception`` is a small wrapper around that
-so that it works with the stock Zope 3 application server.
+``z3c.evalexception`` provides two WSGI middlewares for debugging web
+applications running on the ``zope.publisher`` object publishing
+framework (e.g. Zope 3).  Both middlewares will intercept an exception
+thrown by the application and provide means for debugging.
 
-Here's a simple PasteDeploy configuration file that sets up the Zope 3
-application server on top of the WSGIUtils HTTP server with the
-``z3c.evalexception`` middleware::
+Interactive AJAX debugger
+=========================
 
+``z3c.evalexception.ZopeEvalException`` lets you interactively debug
+exceptions from a browser.  It is a small wrapper around the
+``EvalException`` middleware from ``paste.evalexception``.  You can
+easily refer to it in a PasteDeploy-style configuration file using the
+``ajax`` entry-point:
+
   [filter-app:main]
-  use = egg:z3c.evalexception
+  use = egg:z3c.evalexception#ajax
   next = zope
 
   [app:zope]
-  use = egg:zope.paste
-  site_definition = parts/app/site.zcml
-  file_storage = parts/data/Data.fs
+  use = egg:YourApp
 
   [server:main]
-  use = egg:PasteScript#wsgiutils
+  use = egg:Paste#http
   host = 127.0.0.1
   port = 8080
+
+Post-mortem pdb
+===============
+
+``z3c.evalexception.PostMortemDebug`` invokes pdb's post-mortem mode
+when the application has thrown an exception.  You can refer to it in
+a PasteDeploy-style configuration file using the ``pdb`` entry-point::
+
+  [filter-app:main]
+  use = egg:z3c.evalexception#pdb
+  next = zope
+
+  [app:zope]
+  use = egg:YourApp
+
+  [server:main]
+  use = egg:Paste#http
+  host = 127.0.0.1
+  port = 8080
+
+Changes
+=======
+
+2.0 (2007-08-23)
+----------------
+
+Added the ``PostMortemDebug`` (pdb) middelware.
+
+1.0 (2007-06-02)
+----------------
+
+Initial release, featuring the Zope 3-compatible interactive AJAX
+debugger from Paste.