Merge pull request #1 from m4rcu5nl/feature/prepare-release

Readme, meta and Travis config added

README.md

@@ -1,38 +1,34 @@
-Role Name
+Zerotier
 =========
 
-A brief description of the role goes here.
+This Ansible role installs the zerotier-one package from Zerotier's yum repo, adds and authorizes new members to (existing) Zerotier network and tells the new members to join the network.
 
 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.
+This roles requires an access token for the Zerotier API. This enables the role to add new members to a private network and authorizes them. Also, the role needs the network ID of the Zerotier network the new members should join.
 
 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.
+###zerotier_api_url
+The url where the Zerotier API lives. Must use https protocol.    
+Default: https://my.zerotier.com
 
-Dependencies
+###zerotier_accesstoken
-------------
+The access token needed to authorize with the Zerotier API. You can generate one in your account settings on my.zerotier.com.
 
-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.
+###zerotier_network_id (required)
+The 16 character network ID of the network the new members should join.
 
 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
+      vars:
+         zerotier_network_id: 1234567890qwerty
+         zerotier_accesstoken: "{{ vault_zerotier_accesstoken }}"
       roles:
-         - { role: username.rolename, x: 42 }
+         - { role: m4rcu5nl.zerotier }
 
-License
--------
-
-BSD
-
-Author Information
-------------------
-
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).

meta/main.yml

@@ -1,7 +1,7 @@
 galaxy_info:
-  author: your name
+  author: Marcus Meurs
-  description: your description
+  description: Install zerotier-one package and add new members to a zerotier network
-  company: your company (optional)
+  company: NULL
 
   # If the issue tracker for your role is not on github, uncomment the
   # next line and provide a value
@@ -14,9 +14,9 @@ galaxy_info:
   # - GPLv3
   # - Apache
   # - CC-BY
-  license: license (GPLv2, CC-BY, etc)
+  license: BSD
 
-  min_ansible_version: 1.2
+  min_ansible_version: 2.0
 
   # If this a Container Enabled role, provide the minimum Ansible Container version.
   # min_ansible_container_version:
@@ -32,7 +32,10 @@ galaxy_info:
   #
   # platforms is a list of platforms, and each platform has a name and a list of versions.
   #
-  # platforms:
+  platforms:
+  - name: EL
+    versions:
+    - 7
   # - name: Fedora
   #   versions:
   #   - all
@@ -44,7 +47,9 @@ galaxy_info:
   #   - 7
   #   - 99.99
 
-  galaxy_tags: []
+  galaxy_tags:
+  - zerotier-one
+  - CentOS 7
     # List tags for your role here, one per line. A tag is a keyword that describes
     # and categorizes the role. Users find roles by searching for tags. Be sure to
     # remove the '[]' above, if you add tags to this list.
@@ -54,4 +59,4 @@ galaxy_info:
 
 dependencies: []
   # List your role dependencies here, one per line. Be sure to remove the '[]' above,
-  # if you add dependencies to this list.
+  # if you add dependencies to this list.