feat: using ansible-role to generate README

README.md

@@ -1,11 +1,11 @@
-# Ansible APT Role
+# Ansible franklinkim.apt role
 
 [![Build Status](https://img.shields.io/travis/weareinteractive/ansible-apt.svg)](https://travis-ci.org/weareinteractive/ansible-apt)
 [![Galaxy](http://img.shields.io/badge/galaxy-franklinkim.apt-blue.svg)](https://galaxy.ansible.com/list#/roles/1366)
 [![GitHub Tags](https://img.shields.io/github/tag/weareinteractive/ansible-apt.svg)](https://github.com/weareinteractive/ansible-apt)
 [![GitHub Stars](https://img.shields.io/github/stars/weareinteractive/ansible-apt.svg)](https://github.com/weareinteractive/ansible-apt)
 
-> `apt` is an [ansible](http://www.ansible.com) role which:
+> `franklinkim.apt` is an [Ansible](http://www.ansible.com) role which:
 >
 > * updates apt
 > * cleans up apt
@@ -19,27 +19,35 @@
 
 Using `ansible-galaxy`:
 
-```
+```shell
 $ ansible-galaxy install franklinkim.apt
 ```
 
 Using `requirements.yml`:
 
-```
+```yaml
 - src: franklinkim.apt
 ```
 
 Using `git`:
 
-```
+```shell
 $ git clone https://github.com/weareinteractive/ansible-apt.git franklinkim.apt
 ```
 
+## Dependencies
+
+* Ansible >= 1.9
+
 ## Variables
 
 Here is a list of all the default variables for this role, which are also available in `defaults/main.yml`.
 
-```
+```yaml
+---
+# For more information about default variables see:
+# http://www.ansibleworks.com/docs/playbooks_variables.html#id26
+#
 # apt_unattended_upgrades_blacklist:
 #   - vim
 #   - libc6
@@ -49,7 +57,6 @@ Here is a list of all the default variables for this role, which are also availa
 # apt_keys:
 #   - keyserver: keyserver.ubuntu.com
 #     id: 36A1D7869245C8950F966E92D8576A8BA88D21E9
-#
 
 # sets the amount of time the cache is valid
 apt_cache_valid_time: 3600
@@ -85,7 +92,7 @@ apt_unattended_upgrades_minimal_steps: no
 apt_mails: []
 # Set this value to "true" to get emails only on errors. Default
 # is to always send a mail if Unattended-Upgrade::Mail is set
-apt_unattended_upgrades_notify_always: no
+apt_unattended_upgrades_notify_error_only: yes
 # do automatic removal of new unused dependencies after the upgrade
 # (equivalent to apt-get autoremove)
 apt_unattended_upgrades_autoremove: yes
@@ -99,11 +106,17 @@ apt_remount_filesystem:
 apt_repositories: []
 # gpg keys for external repositories
 apt_keys: []
+
 ```
 
-## Example playbook
 
-```
+## Usage
+
+This is an example playbook:
+
+```yaml
+---
+
 - hosts: all
   sudo: yes
   roles:
@@ -115,12 +128,14 @@ apt_keys: []
       - tree
     apt_mails:
       - root
-    apt_unattended_upgrades_notify_always: yes
+    apt_unattended_upgrades_notify_error_only: no
+
+
 ```
 
 ## Testing
 
-```
+```shell
 $ git clone https://github.com/weareinteractive/ansible-apt.git
 $ cd ansible-apt
 $ vagrant up
@@ -135,5 +150,12 @@ In lieu of a formal styleguide, take care to maintain the existing coding style.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+*Note: To update the `README.md` file please install and run `ansible-role`:*
+
+```shell
+$ gem install ansible-role
+$ ansible-role docgen
+```
+
 ## License
 Copyright (c) We Are Interactive under the MIT license.

meta/readme.yml

@@ -0,0 +1,18 @@
+---
+
+galaxy_name: franklinkim.apt
+github_user: weareinteractive
+github_name: ansible-apt
+badges: |
+  [![Build Status](https://img.shields.io/travis/weareinteractive/ansible-apt.svg)](https://travis-ci.org/weareinteractive/ansible-apt)
+  [![Galaxy](http://img.shields.io/badge/galaxy-franklinkim.apt-blue.svg)](https://galaxy.ansible.com/list#/roles/1366)
+  [![GitHub Tags](https://img.shields.io/github/tag/weareinteractive/ansible-apt.svg)](https://github.com/weareinteractive/ansible-apt)
+  [![GitHub Stars](https://img.shields.io/github/stars/weareinteractive/ansible-apt.svg)](https://github.com/weareinteractive/ansible-apt)
+description: |
+  > * updates apt
+  > * cleans up apt
+  > * configures apt
+  > * installs packages
+  > * add repositories
+  > * add keys
+  > * manages unattended upgrades