chore: Updated Readme.md 🔧 [skip ci]

README.md

@@ -1,40 +1,89 @@
 # Common [![status-badge](https://hub.cybercinch.nz/cybercinch/ansible-role-common/actions/workflows/ci.yml/badge.svg)](https://hub.cybercinch.nz/cybercinch/ansible-role-common/actions?workflow=ci.yml)
 =========
 
-A brief description of the role goes here.
+This role is a collection of functionality to ease common setup of Linux based VM's. Some functionality for windows servers is available.
+
+Features:
+* Dynamic motd - This displays information to administrators at login.
+* Helper commands - These are commands to help with online resizing of Linux Partitions/Drives when running on VMWare.
+* Set DNS resolvers for use on the host.
+* Install common packages for the host (Win/Linux)
 
 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.
+Nil
 
 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.
+Role variables can be found in defaults/main.yml
+
+```yaml
+domain: exampledomain.com
+ad_domain_joined: no
+win_timezone: New Zealand Standard Time
+vendors_hosts: []
+
+dns_servers:
+  - 1.0.0.1
+  - 1.1.1.1
+
+admin_group: admins
+
+
+common_grub_timeout: 5
+postfix_configure: false
+
+common_packages: # Packages we will/would like to install
+  - nano
+  - git
+  - htop
+  - atop
+  - wget
+  - bind-utils
+  - yum-utils
+  - unzip
+
+win_packages:
+  - notepadplusplus.install
+  - firefoxesr
+  - baretail
+  - 7zip.install
+
+apply_win_updates: false
+
+common_show_ipv6: false|bool
+common_root_pwd: $y0urp@$$ ## You should always use a vault encrypted string here.
+common_root_email: admin@somplace.co.nz # Configures forwarding address for root.
+```
 
 Dependencies
 ------------
 
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+Nil external dependencies.  Requires only builtin functions
 
 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:
+This is an example playbook.  Executes the role overriding two variables. 
+
+You could alternately set these in host_vars or group_vars:
 
 ```yaml
-    - hosts: servers
+    - hosts: server
       roles:
-         - { role: username.rolename, x: 42 }
+         - { role: cybercinch.common, 
+             common_show_ipv6: true,
+             common_root_email: iamroot@example.com }
 ```
 
 License
 -------
 
-BSD
+MIT
 
 Author Information
 ------------------
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+This role was created in 2017 by [Aaron Guise](https://guise.net.nz/)