initial commit

README.md

@@ -1,3 +1,35 @@
 # kaya
 
-A lightweight ASGI/RSGI web framework
+A lightweight ASGI/RSGI web framework with method-aware routing, path matching, and recursive wildcard support.
+
+## Build & run locally
+
+Install dev dependencies:
+
+```bash
+pip install --index-url https://gitea.woggioni.net/api/packages/woggioni/pypi/simple --extra-index-url https://pypi.org/simple -r requirements-dev.txt
+```
+
+Build the package:
+
+```bash
+python -m build
+```
+
+Run the example:
+
+```bash
+python example/hello.py
+```
+
+## Tests
+
+```bash
+PYTHONPATH=src python -m unittest discover tests
+```
+
+## Static analysis
+
+```bash
+mypy src/kaya
+```