Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Roderik van der Veer committed Sep 26, 2015
1 parent 25d2be0 commit c654e87
Showing 1 changed file with 10 additions and 29 deletions.
39 changes: 10 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,19 @@
Role Name
=========
# superlumic-homebrew

A brief description of the role goes here.
Ansible role to install Homebrew on OSX. This role is part of the Superlumic project that aims to simplify repeat computer setups on OSX, 10.10 and up.

Requirements
------------
## 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.
* OSX 10.10 or 10.11

Role Variables
--------------
# Usage

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.
Check [Superlumic](https://github.com/superlumic/superlumic) for documentation

Dependencies
------------
# License

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.
MIT

Example Playbook
----------------
# Author

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 }

License
-------

BSD

Author Information
------------------

An optional section for the role authors to include contact information, or a website (HTML is not allowed).
[Roderik van der Veer](mailto:roderik@superlumic.com) - [@r0derik](https://twitter.com/r0derik)

0 comments on commit c654e87

Please sign in to comment.