📝 docs(readme): rewrite following Diataxis framework (#238)

Author: gaborbernat

.github/workflows/check.yaml

@@ -7,11 +7,9 @@ on:
   pull_request:
   schedule:
     - cron: "0 8 * * *"
-
 concurrency:
   group: check-${{ github.ref }}
   cancel-in-progress: true
-
 jobs:
   test:
     name: test with ${{ matrix.env }} on ${{ matrix.os }}

.github/workflows/release.yaml

@@ -2,10 +2,8 @@ name: Release to PyPI
 on:
   push:
     tags: ["*"]
-
 env:
   dists-artifact-name: python-package-distributions
-
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -26,7 +24,6 @@ jobs:
         with:
           name: ${{ env.dists-artifact-name }}
           path: dist/*
-
   release:
     needs:
       - build

.mdformat.toml

@@ -0,0 +1,2 @@
+wrap = 120
+number = true

.pre-commit-config.yaml

@@ -24,11 +24,18 @@ repos:
       - id: ruff-format
       - id: ruff-check
         args: ["--fix", "--unsafe-fixes", "--exit-non-zero-on-fix"]
-  - repo: https://github.com/rbubley/mirrors-prettier
-    rev: "v3.8.1"
+  - repo: https://github.com/hukkin/mdformat
+    rev: "1.0.0"
     hooks:
-      - id: prettier
-        args: ["--print-width=120", "--prose-wrap=always"]
+      - id: mdformat
+        additional_dependencies:
+          - mdformat-config>=0.2.1
+          - mdformat-gfm>=1
+          - mdformat-toc>=0.5
+  - repo: https://github.com/google/yamlfmt
+    rev: "v0.21.0"
+    hooks:
+      - id: yamlfmt
   - repo: meta
     hooks:
       - id: check-hooks-apply