doc: add readme

Author: Daillusorisch

README.md

@@ -0,0 +1,11 @@
+# sts_reader
+
+Just because I think python is too slow
+
+only provide one API for now: 
+
+```python
+def read_sts(path: str) -> tuple[np.ndarray, np.ndarray]: ...
+```
+
+and it assumes you're reading MAG data from MAVEN...

pyproject.toml

@@ -5,6 +5,7 @@ build-backend = "maturin"
 [project]
 name = "sts_reader"
 description = "A Python library for reading STS files using Rust and PyO3."
+readme = "README.md"
 version = "0.1.0"
 requires-python = ">=3.8"
 classifiers = [