doc: update doc with new features

Author: oyale

README.md

@@ -1,16 +1,7 @@
-# Ansible role for Installing Nginx, compiling ModSecurity3, and installing the OWASP CRS v3 ruleset 
+# nginx_modsec3_crs role
+## Ansible role for Installing Nginx, compiling ModSecurity3, and installing the OWASP CRS v3 ruleset 
 
-ModSecurity3 is a powerful open source cross-platform web application firewall (WAF).
-
-https://modsecurity.org/
-
-It goes hand in hand with a ruleset known as OWASP CRS.
-
-https://modsecurity.org/crs/
-
-Additionally both of these go hand in hand with a webserver, either Apache or Nginx, this role only supports Nginx however.
-
-https://www.nginx.com
+Forked from @perryk's [ansible-role-nginx-modsec3-crs3](https://github.com/perryk/ansible-role-nginx-modsec3-crs3)
 
 There are a number of libraries and packages which ModSecurity3 depends on and will be installed via this role.
 
@@ -20,11 +11,7 @@ Nginx support is primarily provided by the dependent role `ansible-role-nginx` b
 
 https://github.com/jdauphant/ansible-role-nginx
 
-By default this role will install Nginx packages from OS provided repos, this is recommended to be changed to installing from the official Nginx repo instead.
-
-This can be done by setting this variable:
-
-```    nginx_official_repo: True```
+:warning:  jdauphant's nginx role is no longer mantained.
 
 ## Requirements
 
@@ -35,26 +22,33 @@ Install any required [Ansible](https://www.ansible.com) roles from `requirements
 ```bash
 ansible-galaxy install -r requirements.yml
 ```
-
-n.b in particular this role will call certain tasks from the nginx role so be sure to have it installed in the same location as this role and with a specific name of "ansible-role-nginx".
-
 i.e this in the requirements.yml file for your project's playbook (not the requirements.yml file for this role) you will need to include both this role and the role mentioned above like this:
 
 ```yml
-- src: perryk.nginx_modsec3_crs3
+- src: coopdevs.nginx_modsec3_crs
 
-- src: https://github.com/jdauphant/ansible-role-nginx
-  version: master
+- src: jdauphant.nginx
+  version: v2.21.2
 ```
 
-
 ## Role Variables
 
 Browse the role's [defaults/main.yml](defaults/main.yml) and [vars/main.yml](vars/main.yml) files to see if there is anything you would like to change or need to override by setting in your playbook.
 
-There are currently no variables of note being set.
+Specific-role vars are explained below, with their default value set.
 
-There are lots of variables however in the nginx role, perhaps the best explanation of these are all the examples in the role [README.md](https://github.com/jdauphant/ansible-role-nginx/blob/master/README.md) file.
+```yaml
+# Enables the modsecurity compilation, installation and configuration if it is not installed
+nginx_modsec3_enabled: True
+ # Set the ruleset version
+nginx_modsec3_crs_version: v3.4/dev
+# Force modsecurity task despite it is already installed
+nginx_modsec3_crs3_force_compile: False
+# Enable the block mode (if False, then "Detection Only" mode is set)
+nginx_modsec3_crs3_block_mode: True
+```
+
+There are lots of variables more in the nginx role, perhaps the best explanation of these are all the examples in the role [README.md](https://github.com/jdauphant/ansible-role-nginx/blob/master/README.md) file.
 
 
 ## Example Playbook
@@ -75,15 +69,12 @@ Example playbook calling the role adding and enabling ModSecurity for the defaul
       - ngx_http_modsecurity_module
     nginx_sites:
       default:
-       - listen 80
-       - server_name _
-       - "Modsecurity on"
-       - "modsecurity_rules_file /etc/nginx/modsec/main.conf"
-       - root "/usr/share/nginx/html"
-       - index index.html
-
+       - ...
+       - modsecurity on;
+       - modsecurity_rules_file /etc/nginx/modsec/main.conf;
+       - ...
   roles:
-    - perryk.nginx-modsec3-crs3
+    - coopdevs.nginx_modsec3_crs
 ```
 
 # License
@@ -93,4 +84,5 @@ MIT
 ## Author Information
 
 Perry Kollmorgen - https://github.com/perryk
+Coopdevs - https://coopdevs.org