update Readme for role

Author: DenAV

roles/npm-management/README.md

@@ -1,17 +1,36 @@
-Role Name
+## NPM-MANAGEMENT
+Ansible role for [Nginx Proxy Manager v2.9.18](https://github.com/NginxProxyManager/nginx-proxy-manager/tree/v2.9.18).
+a simple way to add a new proxy host via ansible playbook.
+Checked for version v2.9.18.
 =========
 
-A brief description of the role goes here.
+description
+-----------
+
+a simple way to add a new proxy host or to delete via ansible playbook
 
 Requirements
 ------------
 
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+This role requires Ansible 2.7 or higher, Docker and Docker-Compose.
+
+Change and update a [docker-compose.yml](https://github.com/DenAV/nginx-proxy-manager-ansible/blob/main/docker/docker-compose_npm.yml) file. Bring up your stack by running docker-compose, further info [here](https://github.com/DenAV/nginx-proxy-manager-ansible/tree/main/docker).
 
 Role Variables
 --------------
 
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+- `npm_api_url` - IP for the Nginx Proxy Manager REST API. Default to `http://192.168.1.5:81/api`.
+- `npm_user` - User to authenticate the Nginx Proxy Manager REST API.
+- `npm_password` - Password to authenticate the Nginx Proxy Manager REST API.
+- `npm_access_token` - Tokens are required to authenticate against the API.
+
+- `npm_api_domain_name` - Domain Names are required to create the Proxy host.
+- `npm_api_host` - Forward Hostname / IP are required to create the Proxy host.
+- `npm_api_ssl_forced` - Is SSL Forced? Default is `False`.
+- `npm_api_create_host` - IWhether to create (present), or no a proxy host. Default is `False`.
+
+See the [`defaults/main.yml`](https://github.com/DenAV/nginx-proxy-manager-ansible/blob/main/roles/npm-management/defaults/main.yml) or [`vars/*.yml`](https://github.com/DenAV/nginx-proxy-manager-ansible/tree/main/roles/npm-management/vars) file listing all possible options which you can be passed to a runner registration command.
+
 
 Dependencies
 ------------
@@ -23,9 +42,18 @@ Example Playbook
 
 Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
 
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
+```yaml
+- name: NPM - create proxy host
+  hosts: localhost
+  gather_facts: no
+
+  roles:
+    - role: npm-management
+      npm_api_domain_name: "site-2.example.com"
+      npm_api_host: "172.16.1.2"
+      npm_api_ssl_forced: True
+      npm_api_create_host: True
+```
 
 License
 -------
@@ -35,4 +63,6 @@ BSD
 Author Information
 ------------------
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+https://github.com/DenAV
+
+