Move usage docs into README.rst
authorKarl O. Pinc <kop@meme.com>
Fri, 26 Oct 2018 00:49:09 +0000 (19:49 -0500)
committerKarl O. Pinc <kop@meme.com>
Fri, 26 Oct 2018 00:49:09 +0000 (19:49 -0500)
README.rst
src/pgwui_common/__init__.py

index 31bbd65b3fe757c17793fa6cffbf5b2b2447e801..5dc6a743da6884d2542b36a999ed0ff1abb47982 100644 (file)
@@ -41,6 +41,23 @@ discovering and reporting as many errors as is possible per bulk
 interaction with the database.
 
 
+Usage
+-----
+
+To use pgwui_common configure your pyramid app by putting the
+following into your package's __init__.py::
+
+    from pyramid.config import Configurator
+
+    def main(global_config, **settings):
+        config = Configurator()
+        config.include('pgwui_common')
+
+Note that you can override any of the assets in this package or any of
+the PGWUI packages, any of the templates or css, using Pyramid's Asset
+Override API (or via pyramid.includes = yourextension in the .ini file).
+
+
 Development Status
 ------------------
 
index 504dad1acf9f1b9e54fbada836256f2636affb46..2ab8c42840b568809a79724becad45dc9af5e39b 100644 (file)
 # Karl O. Pinc <kop@meme.com>
 
 '''Provide a way to configure PGWUI.
-
-To use pgwui_common configure your pyramid app by putting the
-following into your package's __init__.py:
-
-    from pyramid.config import Configurator
-
-    def main(global_config, **settings):
-        config = Configurator()
-        config.include('pgwui_common')
-
-Note that you can override any of the assets in this package or any of
-the PGWUI packages, any of the templates or css, using Pyramid's Asset
-Override API (or via pyramid.includes = yourextension in the .ini file).
-
 '''