aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJosh Cooper <josh@puppet.com>2018-11-26 15:11:13 -0800
committerJosh Cooper <josh@puppet.com>2018-11-26 15:33:59 -0800
commit525274766fb901c92e5b3ab6bf6467ca3d6f1e7b (patch)
treec75ea56f33370d327dea3877f777cb5e072ff38f /README.md
parentf422279080ae4361d2b29451d49a482b2d54c8af (diff)
downloadpuppet-hosts_core-525274766fb901c92e5b3ab6bf6467ca3d6f1e7b.tar.gz
puppet-hosts_core-525274766fb901c92e5b3ab6bf6467ca3d6f1e7b.tar.bz2
Refer to local reference instead of type reference
Also remove redundant `Usage` section. See MODULES-8182.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 2 insertions, 6 deletions
diff --git a/README.md b/README.md
index 4710d26..88011b0 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
#### Table of Contents
1. [Description](#description)
-2. [Usage - Configuration options and additional functionality](#usage)
+2. [Reference](#reference)
3. [Development - Guide for contributing to the module](#development)
## Description
@@ -24,13 +24,9 @@ host { 'localhost':
}
```
-## Usage
-
-For details on usage, please see [the host puppet docs](https://puppet.com/docs/puppet/latest/types/host.html).
-
## Reference
-Please see REFERENCE.md for the reference documentation.
+Please see [`REFERENCE.md`](REFERENCE.md) for the reference documentation.
This module is documented using Puppet Strings.