From 1ffc33872060277fb2f19a44e0c98858ba85a0ae Mon Sep 17 00:00:00 2001
From: Amir Raminfar <findamir@gmail.com>
Date: Sat, 1 Mar 2025 08:21:46 -0800
Subject: [PATCH] chore: adds readme to examples

---
 examples/README.me | 6 ++++++
 1 file changed, 6 insertions(+)
 create mode 100644 examples/README.me

diff --git a/examples/README.me b/examples/README.me
new file mode 100644
index 00000000..160ab0f0
--- /dev/null
+++ b/examples/README.me
@@ -0,0 +1,6 @@
+> [!WARNING]
+> This directory contains examples that are used for testing and demonstration purposes. The configurations may vary and use different tags that are not wanted for the production environment.
+
+This directory contains scripts to setup swarm, k8s, and other environments. There is also examples to demonstrate how to use Dozzle with different environments. I use these examples to test and demonstrate the functionality of Dozzle.
+
+For official documentation, please visit [https://dozzle.dev](https://dozzle.dev).