From d5a378a2dcfd66c777b33b29413bca9697131839 Mon Sep 17 00:00:00 2001 From: mik-tf Date: Tue, 4 Nov 2025 10:48:38 -0500 Subject: [PATCH] docs: Rename example README files to use example-name.md format --- README.md | 12 ++++++------ examples/hello-world/{README.md => hello-world.md} | 0 2 files changed, 6 insertions(+), 6 deletions(-) rename examples/hello-world/{README.md => hello-world.md} (100%) diff --git a/README.md b/README.md index 3e8a34f..6753fd3 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ Mycelium Cloud uses peer-to-peer networking that enables: ├── 📄 .gitignore └── 📁 examples/ ← Standalone examples └── 📁 hello-world/ ← Start here for your first app - ├── 📄 README.md + ├── 📄 hello-world.md ├── 📄 hello-world-deployment.yaml └── 📄 hello-world-service.yaml ``` @@ -192,10 +192,10 @@ Each example follows the same pattern: ``` 📁 example-name/ -├── 📄 README.md ← Complete guide + troubleshooting -├── 📄 example-deployment.yaml ← Application logic -├── 📄 example-service.yaml ← Networking -└── 📁 src/ (optional) ← Source files for customization +├── 📄 example-name.md ← Complete guide + troubleshooting +├── 📄 example-deployment.yaml ← Application logic +├── 📄 example-service.yaml ← Networking +└── 📁 src/ (optional) ← Source files for customization ``` ## Troubleshooting @@ -312,6 +312,6 @@ See [LICENSE](LICENSE) file for details. ## 🚀 Ready to Deploy? -Start with the [Hello World example](examples/hello-world/README.md) - it's designed to get you up and running in 5 minutes! +Start with the [Hello World example](examples/hello-world/hello-world.md) - it's designed to get you up and running in 5 minutes! **Happy deploying! 🎉** \ No newline at end of file diff --git a/examples/hello-world/README.md b/examples/hello-world/hello-world.md similarity index 100% rename from examples/hello-world/README.md rename to examples/hello-world/hello-world.md