diff --git a/README.md b/README.md index 413f109317ee8faee3e9f88f7817006947beeed4..cd353eb9940c54e805017eae195d3b2a52858045 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,10 @@ This role requires Ansible 2.0 or higher. Role Variables -------------- -If you're only trying to set up a host as a NTP client, then you can stick with the defaults. You may want to update the `ntp_pools` variable to point to a closer pool, but you don't have to. Most of the other variables are onl;y relevant if you're setting up a NTP server. +If you're only trying to set up a host as a NTP client, then you can stick with +the defaults. You may want to update the `ntp_pools` variable to point to a +closer pool, but you don't have to. Most of the other variables are only +relevant if you're setting up a NTP server. | Variable | Default | Purpose | |----------|---------|---------| @@ -27,7 +30,9 @@ If you're only trying to set up a host as a NTP client, then you can stick with 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: +This is the basic way to use this role. It will install the NTP service, enable +it to start at boot, and configure it to use the `us.pool.ntp.org` public NTP +pool. ``` - hosts: servers