Merge "Improve documentation"
diff --git a/README.rst b/README.rst
index 6be7812..d9a6507 100644
--- a/README.rst
+++ b/README.rst
@@ -17,4 +17,16 @@
Features
--------
-* TODO
+Patrole offers RBAC testing for various OpenStack RBAC policies. It includes
+a decorator that wraps around tests which verifies that when the test calls the
+corresponding api endpoint, access is only granted for correct roles.
+
+There are several possible test flows.
+
+If the rbac_test_role is allowed to access the endpoint
+ - The test passes if no 403 forbidden or RbacActionFailed exception is raised.
+
+If the rbac_test_role is not allowed to access the endpoint
+ - If the endpoint returns a 403 forbidden exception the test will pass
+ - If the endpoint returns something other than a 403 forbidden to indicate
+ that the role is not allowed, the test will raise an RbacActionFailed exception.
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 9bfe14e..b0a6f33 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -14,6 +14,11 @@
$ mkvirtualenv patrole
$ pip install patrole
+Or to install from the source::
+
+ $ navigate to patrole directory
+ $ pip install -e .
+
Configuration Information
#########################
@@ -44,6 +49,11 @@
# The role that you want the RBAC tests to use for RBAC testing
# This needs to be edited to run the test as a different role.
- rbac_role=_member_
+ rbac_test_role=_member_
+
+ # The list of roles that your system contains.
+ # This needs to be updated as new roles are added.
+ rbac_roles=admin,_member_
+
# Tell standard RBAC test cases to run other wise it they are skipped.
rbac_flag=true