Added readme #2070

Job	Run time
Check code formatting with ruff and mypy + tests (3.8)	49s
Test and lint (ubuntu-latest, 3.8)	3m 9s
Check Readme is not outdated (3.8)	31s
Test and lint (ubuntu-latest, 3.9)	5m 26s
Test and lint (ubuntu-latest, 3.10)	5m 28s
Test and lint (ubuntu-latest, 3.11)	5m 12s
Test and lint (ubuntu-latest, 3.12)	5m 46s
Test and lint (windows-latest, 3.8)	5m 37s
Test and lint (windows-latest, 3.9)	8m 23s
Test and lint (windows-latest, 3.10)	9m 22s
Test and lint (windows-latest, 3.11)	8m 14s
Test and lint (windows-latest, 3.12)	8m 54s
Test and lint (macos-latest, 3.8)	4m 43s
Test and lint (macos-latest, 3.9)	13m 31s
Test and lint (macos-latest, 3.10)	7m 43s
Test and lint (macos-latest, 3.11)	6m 57s
Test and lint (macos-latest, 3.12)	8m 28s
	1h 48m 13s

Provide feedback