aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 81d1e11..4710d26 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ The host_core module is used to manage host entries in a hosts file. For most sy
### Beginning with host_core
-To configure a `localhost` host entry to resolve to an `ip` with a list of `host_aliases` use the following:
+To configure a `localhost` host entry to resolve to an `ip` with a list of `host_aliases`, use the following code:
```
host { 'localhost':
@@ -36,7 +36,7 @@ This module is documented using Puppet Strings.
For a quick primer on how Strings works, please see [this blog post](https://puppet.com/blog/using-puppet-strings-generate-great-documentation-puppet-modules) or the [README.md](https://github.com/puppetlabs/puppet-strings/blob/master/README.md) for Puppet Strings.
-To generate documentation locally, run
+To generate documentation locally, run the following command:
```
bundle install
bundle exec puppet strings generate ./lib/**/*.rb