Adjusting README

README.md

@@ -1,31 +1,34 @@
 Role Name
 =========
 
-A brief description of the role goes here.
+This role is a set of tools for maintaining FreeBSD jails using ZFS. The nature of this role is to include the `tasks/jail/main.yml` with the proper variables set up. It will check if the underlying OS version in the jail is outdated, and update if necessary, while calling configured hooks during the process.
+
+I use this on my single server box to maintain separation between various services. Of course, the nature of Ansible does make this rule and anything that uses it, scalable.
 
 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.
+A fairly recent FreeBSD box.
 
 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.
+Variables this role uses are defined in the `defaults/main.yml` file, using sensible defaults. Override then at your convenience.
 
 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 an already existing 'jail template', that is provided by the role `karolyi.freebsd-zfs-jailtemplate`.
 
 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
+    - hosts:
+        - localhost
       roles:
-         - { role: username.rolename, x: 42 }
+         - karolyi.freebsd-jailhost-tools
 
 License
 -------
@@ -35,4 +38,5 @@ BSD
 Author Information
 ------------------
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+László Károlyi: [Linkedin profile](https://linkedin.com/in/karolyi)
+