summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-06-19 21:32:54 +0300
committerPaul Buetow <paul@buetow.org>2026-06-19 21:32:54 +0300
commit6e6cc0b44fce859669bd967c5d98a39074d8251c (patch)
treee7ce72586ba1071cb94f17955f86efdce44340db
parent7fed72298b36c9aecae849a57a615b85f15552d4 (diff)
docs: reference irregular.ninja as a sample shuriken site/config
Link the live irregular.ninja photo album and its codeberg source repo as a ready-to-read example configuration exercising shuriken's features.
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9ab7d1a..69c832e 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,15 @@ shuriken is a Bash script for Unix-like operating systems (such as Linux) that
generates static web photo albums. The resulting album is pure HTML+CSS — no
JavaScript.
+## Example site
+
+[irregular.ninja](https://irregular.ninja) is a live photo album built with
+shuriken. Its source — including the `shuriken.conf`, templates, and publish
+setup — lives at
+[codeberg.org/snonux/irregular.ninja](https://codeberg.org/snonux/irregular.ninja)
+and works as a ready-to-read sample configuration for all of shuriken's
+features.
+
## Quick start
```sh