Adopting suggested readme and usage updates

README.rst

@@ -29,24 +29,29 @@ Nifi-Python-Api: A convenient Python wrapper for the Apache NiFi Rest API
     :alt: License
 
 
-Background
-----------
+Features
+--------
 
-This package provides high-level calls to execute common NiFi tasks
+This package provides two main areas of functionality:
+    - high-level calls to execute common NiFi tasks:
+        - ./nipyapi/canvas.py etc.
+    - a full swagger 2.0 compliant NiFi Rest API interface and Datamodels:
+        - ./nipyapi/swagger_client/apis/flow_api.py etc.
+        - ./nipyapi/swagger_client/models/process_group_entity.py etc.
 
-It leverages a swagger 2.0 compliant client auto-generated using the
-`Swagger Codegen <https://github.com/swagger-api/swagger-codegen>`_ project
 
-For more information on Apache NiFi, please visit `https://nifi.apache.org <https://nifi.apache.org>`_
+Background
+----------
+
+| For more information on Apache NiFi, please visit `https://nifi.apache.org <https://nifi.apache.org>`_
+| For Documentation on this package please visit `https://nipyapi.readthedocs.io. <https://nipyapi.readthedocs.io/en/latest>`_
 
-For Documentation on this package please visit `https://nipyapi.readthedocs.io. <https://nipyapi.readthedocs.io/en/latest>`_
 
 Version Support
 ---------------
 
-Supports NiFi version: 1.2.x
-
-If you require a different version please raise an `issue <https://github.com/Chaffelson/nipyapi/issues>`_
+| Supports NiFi version: 1.2.x
+| If you require a different version please raise an `issue <https://github.com/Chaffelson/nipyapi/issues>`_
 
 Requirements
 ------------
@@ -64,3 +69,7 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack
 
 Inspired by the equivalent Java client maintained over at
 `hermannpencole/nifi-config <https://github.com/hermannpencole/nifi-config>`_
+
+The swagger 2.0 compliant client auto-generated using the
+`Swagger Codegen <https://github.com/swagger-api/swagger-codegen>`_ project,
+and then cleaned / bugfixed by the authors.

docs/devnotes.rst

@@ -28,12 +28,11 @@ Testing on OSX
 There is a known issue with testing newer versions of Python on OSX.
 You may receive an error reporting [SSL: CERTIFICATE_VERIFY_FAILED] when trying to install packages from Pypi
 
-You can fix this by running the following commands:
+You can fix this by running the following commands::
 
     export PIP_REQUIRE_VIRTUALENV=false
     /Applications/Python\ 3.6/Install\ Certificates.command
 
-
 Generate Swagger client
 -----------------------
 

docs/usage.rst

@@ -19,8 +19,7 @@ To fetch the NiFi system's diagnostics::
 To fetch the NiFi system's root Process Group ID::
 
     import nipyapi
-    canvas = nipyapi.Canvas()
-    canvas.get_root_pg_id()
+    nipyapi.Canvas().get_root_pg_id()
 
 Configuration
 -------------