Add README for examples/ directory

brioche-dev · Jun 2, 2024 · 64af508 · 64af508
1 parent 8988218
commit 64af508
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,7 @@
+# Brioche Example Projects
+
+This directory contains some working Brioche example projects. To test out one of these examples yourself:
+
+1. [Install Brioche](https://brioche.dev/docs/installation/)
+2. Checkout this repo somewhere: `git clone https://github.com/brioche-dev/brioche-packages`
+3. Open an example directory and follow the instructions in the `README.md` file