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/gem/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 examples/gem/README.md

(limited to 'examples/gem')

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`.
-- 
cgit v1.2.3