diff --git a/README.md b/README.md index b2f8863..4f0062f 100644 --- a/README.md +++ b/README.md @@ -1 +1,52 @@ -# bm-sitemap \ No newline at end of file +# BlizzCMS Sitemap Module + +[![GitHub stars](https://img.shields.io/github/stars/WoW-CMS/Blizzcms.svg)](https://github.com/WoW-CMS/Blizzcms/stargazers) +[![GitHub license](https://img.shields.io/github/license/WoW-CMS/bm-sitemap.svg)](https://github.com/WoW-CMS/bm-sitemap/blob/main/LICENSE) +![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/WoW-CMS/bm-sitemap?include_prereleases) + +Welcome to the BlizzCMS Sitemap Module! 🚀 +This module empowers you to effortlessly create and manage sitemaps for your website, supercharging search engine indexing and elevating user navigation. + +## ✨ Features + +- **Sitemap Magic:** Seamlessly generate sitemaps for your website. +- **Custom Priorities:** Tailor priorities for your sitemap links. +- **Intuitive Interface:** User-friendly interface for sitemap creation and management. +- **Bulletproof Security:** Robust security measures to safeguard your data. +- **In-Depth Documentation:** Comprehensive documentation to illuminate your path. + +## 🚀 Getting Started + +To embark on your journey with the BlizzCMS Sitemap Module and unlock the secrets within our detailed documentation, please venture to our [GitHub Repository](https://github.com/WoW-CMS/bm-sitemap/). + +## 🛠️ Installation + +1. Clone the repository or download the ZIP archive. +2. Upload the module ZIP file to your BlizzCMS installation. +3. Activate the "Sitemap" Module within the admin panel by navigating to Administration Modules and selecting "Upload Module from ZIP." Ensure that the module ZIP file is named "sitemap.zip." + +Please note that the module should be named "sitemap" (without the "bm-" prefix) to ensure proper installation and functionality. + +## 🌟 Usage + +1. Embark on your quest to the "Sitemap" realm in the admin panel. +2. Harness the powers of the user-friendly interface to craft and manage sitemaps. +3. Sculpt custom priorities for your sitemap's legendary links. +4. With a mere click, conjure sitemaps of extraordinary power. + +## 🤝 Support + +Should you encounter dragons or need guidance on your epic quest, do not hesitate to reach out to our valiant support team. + +## 🚀 Contributing + +We extend an invitation to brave souls from the community! If you wish to contribute to the development of this legendary module, please follow our [Contribution Guidelines](CONTRIBUTING.md). + +## 📜 License + +This module is guarded by the [MIT License](LICENSE). Wield it wisely. + +--- + +Thank you for choosing the BlizzCMS Sitemap Module. May it serve as your trusty companion in your noble quest to enhance website indexing and user experience! +