Document usage
authorKarl O. Pinc <kop@meme.com>
Wed, 14 Nov 2018 15:48:03 +0000 (09:48 -0600)
committerKarl O. Pinc <kop@meme.com>
Wed, 14 Nov 2018 16:10:15 +0000 (10:10 -0600)
README.rst

index 31757952309ad1ad792713318df0b657573f0b13..cf52a2de3a921123ce7ea73d9aeb879b73c6a05b 100644 (file)
@@ -42,6 +42,17 @@ each batch of data in a transaction so that either all the data in the
 batch goes into the database or of the data none does.
 
 
+Usage
+-----
+
+PGWUI_Upload is included when PGWUI is installed.
+
+When writing your own `Pyramid`_ application, in addition to
+configuring ``pgwui_upload``, ``pgwui_common`` must typically be
+configured.  This can be done with any of `Pyramid's <Pyramid_>`_
+configuration mechanisms.
+
+
 URL Configuration
 -----------------
 
@@ -89,3 +100,4 @@ provided by `The Dian Fossey Gorilla Fund
 
 .. _PGWUI_Core: http://pgwui_core.readthedocs.io/
 .. _PostgreSQL: https://www.postgresql.org/
+.. _Pyramid: https://trypyramid.com/