summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-04-19 00:43:47 +0300
committerPaul Buetow <paul@buetow.org>2025-04-19 00:43:47 +0300
commitfce25135c61e50f3ee1ab2f7de92e323f4ba7a51 (patch)
treead7e453b51a20a89626490ab66a6dda1af07d9f0
parentbcc6b0c153aa7271bc9c3a07b217fbd394890024 (diff)
add readme
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..59e1b23
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# WireGuard Mesh Generator
+
+This generates the WireGuard config for my f3s project. This script is run on my Fedora Linux laptop.
+
+## Installation
+
+```sh
+bundler install
+sudo dnf install -y wireguard-tools
+```
+
+## Usage
+
+```sh
+rake
+```
+
+Result:
+
+```sh
+❯ find keys
+keys
+keys/f0
+keys/f0/privkey
+keys/f0/pubkey
+keys/f1
+keys/f1/privkey
+keys/f1/pubkey
+keys/f2
+keys/f2/privkey
+keys/f2/pubkey
+keys/r0
+keys/r0/privkey
+keys/r0/pubkey
+keys/r1
+keys/r1/privkey
+keys/r1/pubkey
+keys/r2
+keys/r2/privkey
+keys/r2/pubkey
+```