docs: convert README to md

also fix CI badge

Author: 2bndy5

README.md

@@ -0,0 +1,22 @@
+# sphinx-social-cards
+
+[![Test CI][test-ci-badge]][test-ci-link]
+[![Latest version on PyPI][pypi-badge]][pypi-link]
+[![Total PyPI downloads][pypi-dl-badge]][pypi-dl-link]
+[![ReadTheDocs Status][rtd-badge]][rtd-link]
+[![Code Coverage][codecov-badge]][codecov-link]
+
+A Sphinx extension that generates social media cards.
+
+See documentation hosted at <https://2bndy5.github.io/sphinx-social-cards>
+
+[test-ci-badge]: https://github.com/2bndy5/sphinx-social-cards/actions/workflows/test.yml/badge.svg
+[test-ci-link]: https://github.com/2bndy5/sphinx-social-cards/actions/workflows/test.yml
+[pypi-badge]: https://img.shields.io/pypi/v/sphinx-social-cards.svg
+[pypi-link]: https://pypi.python.org/pypi/sphinx-social-cards
+[pypi-dl-badge]: https://static.pepy.tech/personalized-badge/sphinx-social-cards?period=total&units=international_system&left_color=grey&right_color=blue&left_text=PyPi%20Downloads
+[pypi-dl-link]: https://pepy.tech/project/sphinx-social-cards
+[rtd-badge]: https://readthedocs.org/projects/sphinx-social-cards/badge/?version=latest
+[rtd-link]: https://sphinx-social-cards.readthedocs.io/en/latest/?badge=latest
+[codecov-badge]: https://codecov.io/github/2bndy5/sphinx-social-cards/branch/main/graph/badge.svg?token=I6E0KUANUO
+[codecov-link]: https://codecov.io/github/2bndy5/sphinx-social-cards

README.rst

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "sphinx-social-cards"
 description = "Generate social media cards for documentation pages with Sphinx"
-readme = "README.rst"
+readme = "README.md"
 keywords = ["sphinx", "social", "cards", "previews"]
 license = "MIT"
 requires-python = ">=3.9"