From 53b05a3bab6079ad8fafbb3373eca5c1590e2b8d Mon Sep 17 00:00:00 2001
From: jorenham <jhammudoglu@gmail.com>
Date: Thu, 29 Aug 2024 15:14:27 +0200
Subject: [PATCH] improved the `README.md`

---
 .editorconfig      |  4 +--
 .markdownlint.yaml | 29 ++++++++++++++++
 README.md          | 87 ++++++++++++++++++++++++++++++++++++++++------
 3 files changed, 108 insertions(+), 12 deletions(-)
 create mode 100644 .markdownlint.yaml

diff --git a/.editorconfig b/.editorconfig
index 74f69fdd..c2ed0b51 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -11,9 +11,9 @@ indent_style = space
 trim_trailing_whitespace = true
 
 # 4 space indentation
-[*.{py, pyi}]
+[*.{py, pyi, .md}]
 indent_size = 4
 
 # 2 space indentation
-[{*.json,*.jsonc,*.md,*.yml,*.yaml}]
+[*.{json, jsonc, yml, yaml}]
 indent_size = 2
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
new file mode 100644
index 00000000..5362ee32
--- /dev/null
+++ b/.markdownlint.yaml
@@ -0,0 +1,29 @@
+default: true
+no-hard-tabs: true
+
+MD007:
+  indent: 4
+MD013:
+  line_length: 88
+MD031:
+  list_items: false
+MD033:
+  allowed_elements:
+    - h1
+    - p
+    - br
+    - a
+    - i
+    - code
+    - sup
+    - sub
+    - img
+    - table
+    - tr
+    - th
+    - td
+    - dl
+    - dt
+    - dd
+    - details
+    - summary
diff --git a/README.md b/README.md
index 9f0fd1c8..25f3f17e 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,83 @@
-# scipy-stubs
+<h1 align="center">scipy-stubs</h1>
 
-Typing stubs for [scipy](https://github.com/scipy/scipy).
+<p align="center">
+    Building blocks for precise & flexible type hints.
+</p>
 
-> [!IMPORTANT]
-> This project is in the early development stage, and is not ready for production use.
+<p align="center">
+    <a href="https://pypi.org/project/scipy-stubs/">
+        <img
+            alt="scipy-stubs - PyPI"
+            src="https://img.shields.io/pypi/v/scipy-stubs?style=flat&color=olive"
+        />
+    </a>
+    <a href="https://github.com/jorenham/scipy-stubs">
+        <img
+            alt="scipy-stubs - Python Versions"
+            src="https://img.shields.io/pypi/pyversions/scipy-stubs?style=flat"
+        />
+    </a>
+    <a href="https://github.com/jorenham/scipy-stubs">
+        <img
+            alt="scipy-stubs - dependencies"
+            src="https://img.shields.io/librariesio/github/jorenham/scipy-stubs?style=flat&color=violet"
+        />
+    </a>
+    <a href="https://github.com/jorenham/scipy-stubs">
+        <img
+            alt="scipy-stubs - license"
+            src="https://img.shields.io/github/license/jorenham/scipy-stubs?style=flat"
+        />
+    </a>
+</p>
+<p align="center">
+    <!-- TODO -->
+    <!-- <a href="https://github.com/jorenham/scipy-stubs/actions?query=workflow%3ACI">
+        <img
+            alt="scipy-stubs - CI"
+            src="https://github.com/jorenham/scipy-stubs/workflows/CI/badge.svg"
+        />
+    </a> -->
+    <!-- TODO -->
+    <!-- <a href="https://github.com/pre-commit/pre-commit">
+        <img
+            alt="scipy-stubs - pre-commit"
+            src="https://img.shields.io/badge/pre--commit-enabled-teal?logo=pre-commit"
+        />
+    </a> -->
+    <a href="https://github.com/KotlinIsland/basedmypy">
+        <img
+            alt="scipy-stubs - basedmypy"
+            src="https://img.shields.io/badge/basedmypy-checked-fd9002"
+        />
+    </a>
+    <a href="https://detachhead.github.io/basedpyright">
+        <img
+            alt="scipy-stubs - basedpyright"
+            src="https://img.shields.io/badge/basedpyright-checked-42b983"
+        />
+    </a>
+    <a href="https://github.com/astral-sh/ruff">
+        <img
+            alt="scipy-stubs - ruff"
+            src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"
+        />
+    </a>
+</p>
+
+---
 
 ## Installation
 
-```bash
+The `scipy-stubs` package is available as on PyPI:
+
+```shell
 pip install scipy-stubs
 ```
 
+> [!IMPORTANT]
+> This project is in the early development stage, and is not ready for production use.
+
 ## Development Progress
 
 | Module                            | Stubs status    |
@@ -55,8 +122,8 @@ pip install scipy-stubs
 
 Status labels:
 
-1. missing (failed stubgen)
-2. skeleton (mostly succesful stubgen)
-3. partial (incomplete/broad annotations)
-4. ready (complete & valid annotations, untested)
-5. done (complete, valid, tested, and production-ready)
+0. missing (failed stubgen)
+1. skeleton (mostly succesful stubgen)
+2. partial (incomplete/broad annotations)
+3. ready (complete & valid annotations, untested)
+4. done (complete, valid, tested, and production-ready)