updated readme
diff --git a/README.md b/README.md index 225dd44..a91304c 100644 --- a/README.md +++ b/README.md
@@ -1,38 +1,40 @@ -Role Name +Apigee OPDK Setup Validate Cleanup ========= -A brief description of the role goes here. +This role performs the installation cleanup of the Apigee OPDK validation. 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. +The installation of Apigee OPDK requires root access. Credentials must also be supplied to override the empty placeholders +provided here. It is recommended that credentials be consolidated into a single credentials.yml file that can be stored +separately. It is assumed that files containing credentials are stored in the ~/.apigee folder. 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. +Default values for variables are provided by the role opdk-setup-default-settings. 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. +This role depends on the following roles: + +* opdk-setup-default-settings 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 } + - { role: opdk-setup-validate-cleanup } License ------- -BSD +Apache License Version 2.0, January 2004 Author Information ------------------ -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +Carlos Frias