docs: create README.md

Author: liborjelinek

README.md

@@ -0,0 +1,79 @@
+<div align="center">
+
+[![sphinx-reredirects](https://github.com/documatt/sphinx-reredirects/blob/main/hero.png?raw=true)](https://documatt.com/sphinx-reredirects)
+
+# sphinx-reredirects
+
+<!-- Major intro -->
+**The sphinx-reredirects is the extension for Sphinx documentation projects that handle redirects for moved pages. It generates HTML pages with meta refresh redirects to the new page location to prevent 404 errors if you rename or move your documents.**
+
+<!-- Minor intro -->
+
+The sphinx-reredirects started from the urge to manage redirects for all documents after moving our *Tech writer at work* blog to the new address at https://documatt.com/blog/.
+
+<!-- Highlights in points -->
+<p>
+  <em>
+    Prevents 404 errors
+    · Wildcard matching
+    · Dynamic placeholders
+  </em>
+  <br />
+  <em>
+    Cross-domain redirects
+    · Centralized configuration in <code>conf.py</code>
+  </em>
+  <br />
+  <em>
+    Easy to use
+    · Works seamlessly with Sphinx
+  </em>
+  <br />
+  <em>
+    <a href="https://documatt.com/sphinx-reredirects">
+      📚Documentation
+    </a>
+  </em>
+</p>
+
+<!-- Badges -->
+
+[![GitHub Repo stars](https://img.shields.io/github/stars/documatt/sphinx-reredirects?style=flat&logo=github&labelColor=097cba&color=163B36)](https://github.com/documatt/sphinx-reredirects)
+[![GitHub tests](https://github.com/documatt/sphinx-reredirects/actions/workflows/tests.yml/badge.svg)](https://github.com/documatt/sphinx-reredirects/actions/workflows/tests.yml)
+[![PyPI version](https://img.shields.io/pypi/v/sphinx-reredirects?labelColor=097cba&color=163B36)](https://pypi.org/project/sphinx-reredirects/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-reredirects?labelColor=097cba&color=163B36)](https://pypi.org/project/sphinx-reredirects/)
+[![MIT licence](https://img.shields.io/badge/license-MIT-blue?labelColor=097cba&color=163B36)](https://raw.githubusercontent.com/documatt/sphinx-reredirects/refs/heads/main/LICENSE)
+</div>
+
+<!-- Very short intro -->
+Good URLs are never changing URLs. But if you must, sphinx-reredirects helps you manage redirects with ease and from a single place in the project's `conf.py`.
+
+For example, if you rename document `start` to `intro`, and tell it to sphinx-reredirects, it will generate the HTML page `start.html` with `<meta http-equiv="refresh" content="0; url=intro.html">`.
+
+The extension supports wildcards and moving to different domains, too.
+
+<!-- Screenshot / video -->
+<div align="center">
+  <img alt="" width="80%" src="https://github.com/documatt/sphinx-reredirects/blob/main/screenshot.png?raw=true">
+</div>
+
+## Community
+
+Connect with other fellows who are building with Sphinx. Share knowledge, get help,
+and contribute to the open-source project. Check out
+our [Documatt Community](https://documatt.com/community) page to see featured material and upcoming events.
+
+Join our community here:
+
+- 🌟 [Explore our GitHub](https://github.com/documatt)
+- 📥 [Subscribe to our newsletter](https://documatt.com/newsletter-signup/)
+- 🐦 [Follow us on X](https://x.com/documattcom)
+- 🕴️ [Follow us on LinkedIn](https://www.linkedin.com/company/documattcom)
+- 📺 [Subscribe to our YouTube channel](https://www.youtube.com/@Documatt)
+- 📚 [Read our blog posts](https://documatt.com/blog)
+
+## Legal
+
+sphinx-reredirects [MIT licensed](https://raw.githubusercontent.com/documatt/sphinx-reredirects/refs/heads/main/LICENSE).
+
+Icon "route-alt-right" by [TabletIcons](https://tablericons.com/icon/route-alt-right).