Updated README

cg_nutanix_vm_create/README.md

@@ -1,24 +1,24 @@
-Role Name - cg_nutanix_vm_create
-=================================
+Ansible Role Name - cg_nutanix_vm_create
+========================================
 
 This ansible role enables the creation of one or more VMs on a single Nutanix cluster.
 
 Requirements
 ------------
 
+- A user-provided tilde-separated-values file containing the specifications of one or more VMs. Refer the sample files/vm.tsv in the role directory.
+- A user-provided variables file containing appropriate values for required variables. Refer the defaults/main.yml in the role directory.
 
 Role Variables
 --------------
 
+- pc_cluster_fqdn   # FQDN/IP for Prism Central
+- pe_cluster_fqdn   # FQDN/IP for Prism Element
+- prism_user        # An account with permissions to provision on the cluster
+- prism_password    # The account's password. Do NOT store this in the clear. Use ansible vault or an external vault. 
+- cluster_name      # Name of the nutanix cluster on which VMs will be created 
+- vm_data_tsv       # Relative path and name of the tilde-separated-values file containing details of the VMs to be deployed
+- global_debug      # Global Debug flag
 
 
 Dependencies
@@ -33,16 +33,16 @@ Example Playbook
 Create a vars/main.yml with the required variables (above) and a files/vm.tsv before
 using the following playbook.
 
----
-- name: Create VMs on Nutanix AHV
-  hosts: localhost
-  gather_facts: false
-  tasks:
-    - name: Include variables
-      include_vars: dir=vars
-    - name: Use ansible role cg_nutanix_vm_create
-      include_role:
-        name: cg_nutanix_vm_create
+    ---
+    - name: Create VMs on Nutanix AHV
+      hosts: localhost
+      gather_facts: false
+      tasks:
+        - name: Include variables
+          include_vars: dir=vars
+        - name: Use ansible role cg_nutanix_vm_create
+          include_role:
+            name: cg_nutanix_vm_create
 
 
 License
@@ -59,4 +59,5 @@ Cybergavin - https://cybergav.in - https://github.com/cybergav.in
 References
 -----------
 
-Influenced/Inspired by the Ansible role mbach04.nutanix_vm_provisioner at https://github.com/mbach04/nutanix_vm_provisioner.
+Influenced/Inspired by the Ansible role mbach04.nutanix_vm_provisioner at https://github.com/mbach04/nutanix_vm_provisioner.
+The ansible role mbach04.nutanix_vm_provisioner is distributed using the MIT License with Copyright (c) 2018 Red Hat.