[Checkins] SVN: zc.async/trunk/src/zc/async/README doc cleanup and additions.

[Gary Poster]

Log message for revision 85227:
  doc cleanup and additions.

Changed:
  U   zc.async/trunk/src/zc/async/README.txt
  U   zc.async/trunk/src/zc/async/README_2.txt
  U   zc.async/trunk/src/zc/async/README_3.txt

-=-
Modified: zc.async/trunk/src/zc/async/README.txt
===================================================================
--- zc.async/trunk/src/zc/async/README.txt	2008-04-11 00:44:31 UTC (rev 85226)
+++ zc.async/trunk/src/zc/async/README.txt	2008-04-11 01:06:46 UTC (rev 85227)
@@ -164,7 +164,7 @@
 makes it possible to get the primary queue with an adaptation call like
 ``zc.async.interfaces.IQueue(a_persistent_object_with_db_connection)``.
 
-But failing that, queues are always exected to be in a zc.async.queue.Queues
+But failing that, queues are always expected to be in a zc.async.queue.Queues
 mapping found off the ZODB root in a key defined by the constant
 zc.async.interfaces.KEY.
 

Modified: zc.async/trunk/src/zc/async/README_2.txt
===================================================================
--- zc.async/trunk/src/zc/async/README_2.txt	2008-04-11 00:44:31 UTC (rev 85226)
+++ zc.async/trunk/src/zc/async/README_2.txt	2008-04-11 01:06:46 UTC (rev 85227)
@@ -508,7 +508,10 @@
 The package supports monitoring using zc.z3monitor, but using this package
 includes more Zope 3 dependencies, so it is not included here. If you would
 like to use it, see monitor.txt in the package and our next section:
-`Configuration with Zope 3`_.
+`Configuration with Zope 3`_. Otherwise, if you want to roll your own
+monitoring, glance at monitor.py--you'll see that most of the heavy lifting for
+the monitor support is done in the dispatcher, so it should be pretty easy to
+hook up the basic data another way.
 
     >>> reactor.stop()
 

Modified: zc.async/trunk/src/zc/async/README_3.txt
===================================================================
--- zc.async/trunk/src/zc/async/README_3.txt	2008-04-11 00:44:31 UTC (rev 85226)
+++ zc.async/trunk/src/zc/async/README_3.txt	2008-04-11 01:06:46 UTC (rev 85227)
@@ -20,6 +20,11 @@
 production, and start up! Getting started is really pretty easy. You can even
 start a dispatcher-only version by not starting any servers in zcml.
 
+In comparison to the non-Zope 3 usage, an important difference in your setup.py
+is that, if you want the full set up described below, including zc.z3monitor,
+you'll need to specify "zc.async [z3]" as the desired package in your
+``install_requires``, as opposed to just "zc.async" [#extras_require]_.
+
 We'll look at this by making a zope.conf-alike and a site.zcml-alike.  We'll
 need a place to put some files, so we'll use a temporary directory.  This, and
 the comments in the files that we set up, are the primary differences between
@@ -225,6 +230,13 @@
 .. Footnotes ..
 .. ......... ..
 
+.. [#extras_require] The "[z3]" is an "extra", defined in zc.async's setup.py
+    in ``extras_require``. It pulls along zc.z3monitor and simplejson in
+    addition to the packages described in the `Configuration without Zope 3`_
+    section. Unfortunately, zc.z3monitor depends on zope.app.appsetup, which as
+    of this writing ends up depending indirectly on many, many packages, some
+    as far flung as zope.app.rotterdam.
+
 .. [#get_vals]
 
     >>> import errno, os, random, socket, tempfile