From 4c2d1e5b2ee0792b1a8ca3b330fd391c6bdb8285 Mon Sep 17 00:00:00 2001
From: Paul Buetow <paul@buetow.org>
Date: Sun, 1 Mar 2026 20:16:17 +0200
Subject: add README.md to each example directory with usage instructions

---
 examples/cli/README.md        | 26 ++++++++++++++++++++++++++
 examples/gem/README.md        | 28 ++++++++++++++++++++++++++++
 examples/plain_ruby/README.md | 22 ++++++++++++++++++++++
 examples/rake/README.md       | 29 +++++++++++++++++++++++++++++
 4 files changed, 105 insertions(+)
 create mode 100644 examples/cli/README.md
 create mode 100644 examples/gem/README.md
 create mode 100644 examples/plain_ruby/README.md
 create mode 100644 examples/rake/README.md

(limited to 'examples')

diff --git a/examples/cli/README.md b/examples/cli/README.md
new file mode 100644
index 0000000..d393a9c
--- /dev/null
+++ b/examples/cli/README.md
@@ -0,0 +1,26 @@
+# Example: Via CLI
+
+Uses RCM through the `rcm` command-line tool.
+
+## Usage
+
+```sh
+# Dry run — show what would change, make no changes
+rcm config.rb --dry
+
+# Verbose output
+rcm config.rb --debug
+
+# Limit execution to specific hosts
+rcm config.rb --hosts earth,mars
+
+# Apply configuration
+rcm config.rb
+```
+
+## What it does
+
+- Creates `/tmp/example/hello.txt` with static content (parent directory created automatically)
+- Creates `/tmp/example/info.txt` from an inline ERB template containing the hostname and current date
+
+Both operations only run when the current hostname is `earth`.
diff --git a/examples/gem/README.md b/examples/gem/README.md
new file mode 100644
index 0000000..c05b844
--- /dev/null
+++ b/examples/gem/README.md
@@ -0,0 +1,28 @@
+# Example: As a Gem
+
+Uses RCM as a Bundler-managed gem inside a Rake project.
+
+## Setup
+
+```sh
+bundle install
+```
+
+## Usage
+
+```sh
+# Dry run — show what would change, make no changes
+bundle exec rake setup -- --dry
+
+# Verbose output
+bundle exec rake setup -- --debug
+
+# Apply configuration
+bundle exec rake setup
+```
+
+## What it does
+
+- Creates `/tmp/example/wg0.conf` from an inline ERB template
+
+The task only runs when the current hostname is `earth`.
diff --git a/examples/plain_ruby/README.md b/examples/plain_ruby/README.md
new file mode 100644
index 0000000..7208317
--- /dev/null
+++ b/examples/plain_ruby/README.md
@@ -0,0 +1,22 @@
+# Example: Plain Ruby Script
+
+Uses RCM directly from a Ruby script — no Rake, no Bundler required.
+
+## Usage
+
+```sh
+# Dry run — show what would change, make no changes
+ruby config.rb --dry
+
+# Verbose output
+ruby config.rb --debug
+
+# Apply configuration
+ruby config.rb
+```
+
+## What it does
+
+- Creates `/tmp/example/hello.txt` with static content (parent directory created automatically)
+- Ensures the line `127.0.0.1 localhost` is present in `/tmp/example/hosts.txt`
+- Creates `/tmp/example/greeting.txt` from an inline ERB template
diff --git a/examples/rake/README.md b/examples/rake/README.md
new file mode 100644
index 0000000..93a83ec
--- /dev/null
+++ b/examples/rake/README.md
@@ -0,0 +1,29 @@
+# Example: With Rake
+
+Uses RCM from a Rake task with a `config.toml` for host group definitions.
+
+## Setup
+
+```sh
+bundle install
+```
+
+## Usage
+
+```sh
+# Dry run — show what would change, make no changes
+rake setup -- --dry
+
+# Verbose output
+rake setup -- --debug
+
+# Apply configuration
+rake setup
+```
+
+## What it does
+
+- Creates `/tmp/example/wg/wg0.conf` from an inline ERB template (parent directory created automatically)
+- Ensures the line `192.168.1.101 earth.local` is present in `/tmp/example/hosts.txt`
+
+Both operations only run when the current hostname is `earth`.
-- 
cgit v1.2.3