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

index 2652e80526897edcaffc8097dd4f1345ec3a41f1..abd0cbc07cb2edb870c6422d50e58153766ee411 100644 (file)
@@ -40,6 +40,17 @@ You will almost always want to install this when installing any of the
 other PGWUI programs.
 
 
+Usage
+-----
+
+PGWUI_Logout is included when PGWUI is installed.
+
+When writing your own `Pyramid`_ application, in addition to
+configuring ``pgwui_logout``, ``pgwui_common`` must typically be
+configured.  This can be done with any of `Pyramid's <Pyramid_>`_
+configuration mechanisms.
+
+
 URL Configuration
 -----------------
 
@@ -78,3 +89,4 @@ provided by `The Dian Fossey Gorilla Fund
 
 
 .. _PostgreSQL: https://www.postgresql.org/
+.. _Pyramid: https://trypyramid.com/