summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-03-01 20:15:44 +0200
committerPaul Buetow <paul@buetow.org>2026-03-01 20:15:44 +0200
commit876a5959cedd3699b2c3eccc71ed78badc3bad55 (patch)
tree2596099f3061fbabecef5704052db9bda3587ea0 /README.md
parent84cf996536b62abe91fa881cdf46b72eb44ee24c (diff)
add quickstart examples directory and link from README
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index ce1f394..c2c480d 100644
--- a/README.md
+++ b/README.md
@@ -40,6 +40,8 @@ This software has been written by a human by 90%, and only the last 10% were AI
### With Rake (from the playground)
+See [examples/rake/](examples/rake/) for a working example.
+
```sh
cd playground
rake wireguard -- --dry
@@ -48,6 +50,8 @@ rake wireguard -- --debug
### As a Gem (from any directory)
+See [examples/gem/](examples/gem/) for a working example.
+
```ruby
# Gemfile
gem 'rcm', path: '~/git/rcm'
@@ -76,6 +80,8 @@ bundle exec rake setup -- --dry
### Plain Ruby Script
+See [examples/plain_ruby/](examples/plain_ruby/) for a working example.
+
```ruby
#!/usr/bin/env ruby
require 'rcm'
@@ -93,6 +99,8 @@ ruby config.rb --dry
### Via CLI
+See [examples/cli/](examples/cli/) for a working example.
+
```sh
rcm config.rb --dry --hosts earth,mars
```