aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Cooper <josh@puppet.com>2018-10-25 16:40:06 -0700
committerGitHub <noreply@github.com>2018-10-25 16:40:06 -0700
commitbd22643b7f6d8755f410ca5e4a11d3e4abf77559 (patch)
tree999a0c3f41f461f9da63f8c6627962afe7305d99
parent0609e86911bf7adc3caffb8d0659ed6af03409d3 (diff)
parent67bec09a17f7891c3ec778378acd577030f0d8f7 (diff)
downloadpuppet-sshkeys_core-bd22643b7f6d8755f410ca5e4a11d3e4abf77559.tar.gz
puppet-sshkeys_core-bd22643b7f6d8755f410ca5e4a11d3e4abf77559.tar.bz2
Merge pull request #9 from ehom/master
(maint) made phrases complete (localization-ready)
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 9c6bef0..4c7b1f4 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ Manage SSH `authorized_keys`, and `ssh_known_hosts` files.
## Usage
-To manage an authorized key for a user:
+To manage an authorized key for a user, use the following code:
```
ssh_authorized_key { 'nick@magpie.example.com':
@@ -25,7 +25,7 @@ ssh_authorized_key { 'nick@magpie.example.com':
}
```
-To manage a known hosts file entry:
+To manage a known hosts file entry, use the following code:
```
sshkey { 'github.com':
@@ -35,7 +35,7 @@ sshkey { 'github.com':
}
```
-More details cana be found in the `REFERENCE.md` file.
+More details can be found in the `REFERENCE.md` file.
## Reference
@@ -45,7 +45,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