Updated docs
diff --git a/README.md b/README.md index 1a63d6b..07e5799 100644 --- a/README.md +++ b/README.md
@@ -1,17 +1,19 @@ -Role Name +Apigee OPDK Setup Status ========= -A brief description of the role goes here. +This repository contains an Ansible role that executes an Apigee status action on all components of a node. 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. +None 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. +| Variable Name | Description | +| --- | --- | +| apigee_all | The cannonical qualified name of the apigee-all script | Dependencies ------------