Merge pull request FidelityInternational#45 from FidelityInternationa…

…l/FIL-849-Updated-documentation

Update README.rst to expand on explanations to what version locking is and how it works

README.rst

@@ -1,20 +1,25 @@
-****************
+
+**************************
 django CMS Version Locking
-****************
+**************************
 
-## Explanation
-The version-locking addon is intended to modify the way djangocms-versioning works.  
-* The primary change is that it locks a version to its author when a draft is created. 
-* That version becomes automatically unlocked again once it is published. 
-* The lock prevents editing of the file by anyone other than the author.
-* Locks can be removed by a user with the correct permission
-* Unlocking an item sends a notification to the author to which it was locked.
-* Manually unlocking a version does not lock it to the unlocking user, nor does it change the author.
-* The Version admin view for each content-type registered with Version-locking will be edited to add in lock icons / buttons UI to the Actions column.
+Explanation
+-----------
+The version-locking addon is intended to modify the way djangocms-versioning works in the following way: 
 
+ - The primary change is that it locks a version to its author when a draft is created. 
+ - The lock prevents editing of the file by anyone other than the author.
+ - That version becomes automatically unlocked again once it is published. 
+ - Locks can be removed by a user with the correct permission
+ - Unlocking an item sends a notification to the author to which it was locked.
+ - Manually unlocking a version does not lock it to the unlocking user, nor does it change the author.
+ - The Version admin view for each content-type registered with Version-locking will be edited to add in lock icons / buttons UI to the Actions column.
 
-## Installation
+Installation
+------------
 The package djangocms-versioning and djangocms-moderation need to be installed for this project to function correctly.
 
-## Configuration
-Version-locking makes use of the django-cms 4.x App Registration mechanism to allow models from other addon's (i.e. content-types) to be registered for use with version-locking. 
+
+Configuration
+-------------
+Version-locking makes use of the django-cms 4.x App Registration mechanism to allow models from other addon's (i.e. content-types) to be registered for use with version-locking. See the cms_config.py file for an example of how. In this file the PageContent model is configured for version-locking.