Improved the pyramidSparkBot example documentation

Author: jbogarin

examples/pyramidSparkBot/README.rst

@@ -1,4 +1,33 @@
 Documentation
 =============
 
-Put a brief description of 'Pyramid Spark Bot application'.
+A simple bot script, built on Pyramid using Cornice
+
+This sample script leverages the Pyramid web framework (https://trypyramid.com/) with
+Cornice (https://cornice.readthedocs.io).  By default the web server will be reachable at
+port 6543 you can change this default if desired (see `pyramidSparkBot.ini`).
+
+ngrok (https://ngrok.com/) can be used to tunnel traffic back to your server
+if your machine sits behind a firewall.
+
+You must create a Spark webhook that points to the URL where this script is
+hosted.  You can do this via the CiscoSparkAPI.webhooks.create() method.
+
+Additional Spark webhook details can be found here:
+https://developer.ciscospark.com/webhooks-explained.html
+
+A bot must be created and pointed to this server in the My Apps section of
+https://developer.ciscospark.com.  The bot's Access Token should be added as a
+'SPARK_ACCESS_TOKEN' environment variable on the web server hosting this
+script.
+
+This script supports Python versions 2 and 3.
+
+# Running the bot
+
+In order to execute the bot, you need to
+
+```
+python setup.py develop
+pserve --reload pyramidSparkBot
+```

examples/pyramidSparkBot/setup.py

@@ -24,7 +24,7 @@
       packages=find_packages(),
       include_package_data=True,
       zip_safe=False,
-      install_requires=['cornice', 'waitress'],
+      install_requires=['cornice', 'waitress', 'ciscosparkapi'],
       entry_points="""\
       [paste.app_factory]
       main=pyramidSparkBot:main