From a06236ee9e264957cfae54b3b6d1a6805f952816 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Romain=20Tarti=C3=A8re?= <romain@blogreen.org>
Date: Tue, 3 Sep 2024 16:18:42 -0700
Subject: [PATCH] Add / fix documentation

---
 README.md         | 61 +++++++++++++++++++++++++++++++++++++++++++++++
 REFERENCE.md      |  4 ++--
 manifests/init.pp |  4 ++--
 metadata.json     |  2 +-
 4 files changed, 66 insertions(+), 5 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a943724
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+# rwhod
+
+<!-- header GFM -->
+[![Build Status](https://img.shields.io/github/actions/workflow/status/opus-codium/puppet-rwhod/release.yml)](https://github.com/opus-codium/puppet-rwhod/releases)
+[![Puppet Forge](https://img.shields.io/puppetforge/v/opuscodium/rwhod.svg)](https://forge.puppetlabs.com/opuscodium/rwhod)
+[![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/opuscodium/rwhod.svg)](https://forge.puppetlabs.com/opuscodium/rwhod)
+[![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/opuscodium/rwhod.svg)](https://forge.puppetlabs.com/opuscodium/rwhod)
+[![Puppet Forge - scores](https://img.shields.io/puppetforge/f/opuscodium/rwhod.svg)](https://forge.puppetlabs.com/opuscodium/rwhod)
+[![License](https://img.shields.io/github/license/opus-codium/puppet-rwhod.svg)](https://github.com/voxpupuli/opuscodium-rwhod/blob/master/LICENSE.md)
+<!-- header -->
+
+#### Table of Contents
+
+<!-- vim-markdown-toc GFM -->
+
+* [Overview](#overview)
+* [Module Description](#module-description)
+* [Setup](#setup)
+  * [What rwhod affects](#what-rwhod-affects)
+  * [Beginning with rwhod](#beginning-with-rwhod)
+* [Limitations](#limitations)
+* [Contributing](#contributing)
+
+<!-- vim-markdown-toc -->
+
+## Overview
+
+Manage the `rwhod(8)` daemon.
+
+## Module Description
+
+This module installs `rwhod(8)` and ensure the service is running.
+
+## Setup
+
+### What rwhod affects
+
+* Installed packages;
+* Running services.
+
+### Beginning with rwhod
+
+The scope of this module is rather limited, so usage should be straightforward:
+
+```puppet
+class { 'rwhod':
+}
+```
+
+## Limitations
+
+The current implementation supports Debian GNU/Linux and FreeBSD.  Patches to
+add support to more platforms are welcome.
+
+## Contributing
+
+1. Fork it ( https://github.com/opus-codium/puppet-rwhod/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create a new Pull Request
diff --git a/REFERENCE.md b/REFERENCE.md
index d38cf00..3dd69a0 100644
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -25,11 +25,11 @@ The following parameters are available in the `rwhod` class:
 
 Data type: `Optional[String]`
 
-
+The name of the rwhod package
 
 ##### <a name="-rwhod--service_name"></a>`service_name`
 
 Data type: `String`
 
-
+The name of the rwhod service
 
diff --git a/manifests/init.pp b/manifests/init.pp
index 3976154..f43f76e 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -1,7 +1,7 @@
 # @summary Manage the rwhod daemon
 #
-# @param package_name
-# @param service_name
+# @param package_name The name of the rwhod package
+# @param service_name The name of the rwhod service
 class rwhod (
   Optional[String] $package_name,
   String $service_name,
diff --git a/metadata.json b/metadata.json
index d1f85d5..6a9db4e 100644
--- a/metadata.json
+++ b/metadata.json
@@ -2,7 +2,7 @@
   "name": "opuscodium-rwhod",
   "version": "0.0.0",
   "author": "Opus Codium",
-  "summary": "Installs, configures, and manages TLS checker",
+  "summary": "Manage the rwhod daemon",
   "license": "Apache-2.0",
   "source": "https://github.com/opus-codium/puppet-rwhod",
   "project_page": "https://github.com/opus-codium/puppet-rwhod",