aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Cooper <josh@puppet.com>2018-10-25 16:34:59 -0700
committerGitHub <noreply@github.com>2018-10-25 16:34:59 -0700
commit699785957bf149e234ba0ec20581e0187b2f4f85 (patch)
tree6448202aa44787fbddd1538157ea279d9a93060b
parent9e459bf2dab04218d54d8d582a44ab81b757336d (diff)
parent256e3c4d1b66246242d96a48424a9fe1cbeef8e6 (diff)
downloadpuppet-augeas_core-699785957bf149e234ba0ec20581e0187b2f4f85.tar.gz
puppet-augeas_core-699785957bf149e234ba0ec20581e0187b2f4f85.tar.bz2
Merge pull request #11 from ehom/master
(maint) made phrases complete (localization-ready)
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index b235347..c5bf0b4 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@
## Description
-The augeas_core module is used to manage configuration files using Augeas. The module is suitable for any host for which there are Augeas libraries and ruby bindings.
+The `augeas_core` module is used to manage configuration files using Augeas. This module is suitable for any host for which there are Augeas libraries and ruby bindings.
## Setup
@@ -24,7 +24,7 @@ The augeas libraries and ruby bindings must be installed in order to use this mo
### Beginning with augeas_core
-To manage a configuration file using `augeas`:
+To manage a configuration file using `augeas`, use the following code:
```
augeas { 'add_services_entry':
@@ -52,7 +52,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