summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c831a87
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# mdit-py-plugins
+
+[![Github-CI][github-ci]][github-link]
+[![Coverage Status][codecov-badge]][codecov-link]
+[![PyPI][pypi-badge]][pypi-link]
+[![Conda][conda-badge]][conda-link]
+[![Code style: black][black-badge]][black-link]
+
+Collection of core plugins for [markdown-it-py](https://github.com/executablebooks/markdown-it-py).
+
+[github-ci]: https://github.com/executablebooks/mdit-py-plugins/workflows/continuous-integration/badge.svg
+[github-link]: https://github.com/executablebooks/mdit-py-plugins
+[pypi-badge]: https://img.shields.io/pypi/v/mdit-py-plugins.svg
+[pypi-link]: https://pypi.org/project/mdit-py-plugins
+[conda-badge]: https://anaconda.org/conda-forge/mdit-py-plugins/badges/version.svg
+[conda-link]: https://anaconda.org/conda-forge/mdit-py-plugins
+[codecov-badge]: https://codecov.io/gh/executablebooks/mdit-py-plugins/branch/master/graph/badge.svg
+[codecov-link]: https://codecov.io/gh/executablebooks/mdit-py-plugins
+[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
+[black-link]: https://github.com/ambv/black
+[install-badge]: https://img.shields.io/pypi/dw/mdit-py-plugins?label=pypi%20installs
+[install-link]: https://pypistats.org/packages/mdit-py-plugins