Merge pull request #162 from mgaitan/tkp/readmepypa

Add pypa-compatible readme

docs/readme_pypa.md

@@ -0,0 +1,10 @@
+# sphinxcontrib-mermaid
+
+[![](https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/test.yml/badge.svg)](https://github.com/mgaitan/sphinxcontrib-mermaid/actions/workflows/test.yml)
+[![](https://img.shields.io/pypi/v/sphinxcontrib-mermaid)](https://pypi.org/project/sphinxcontrib-mermaid/)
+[![](https://img.shields.io/pypi/dm/shbin)](https://libraries.io/pypi/sphinxcontrib-mermaid/)
+
+This extension allows you to embed [Mermaid](https://mermaid.js.org/) graphs in your
+documents, including general flowcharts, sequence diagrams, gantt diagrams and more.
+
+See the [official Documentation](http://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest/) or [project repository](https://github.com/mgaitan/sphinxcontrib-mermaid) for more details!

pyproject.toml

@@ -6,7 +6,7 @@ build-backend="setuptools.build_meta"
 name = "sphinxcontrib-mermaid"
 authors = [{name = "Martín Gaitán", email = "gaitan@gmail.com"}]
 description="Mermaid diagrams in yours Sphinx powered docs"
-readme = "README.rst"
+readme = "docs/readme_pypa.md"
 license = { text = "BSD" }
 version = "1.0.0"
 requires-python = ">=3.8"