add README.md to each example directory with usage instructions

1 files changed, 29 insertions, 0 deletions

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`.