docs: refine README and architecture decision records #11

	name: CI

	on:
	push:
	branches: [main]
	pull_request:
	branches: [main]

	jobs:
	lint:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: actions/setup-python@v5
	with:
	python-version: "3.11"
	- name: Install dependencies
	run: pip install -e ".[dev]"
	- name: Lint
	run: ruff check src/ tests/
	- name: Format check
	run: ruff format --check src/ tests/

	typecheck:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: actions/setup-python@v5
	with:
	python-version: "3.11"
	- name: Install dependencies
	run: pip install -e ".[dev]"
	- name: Type check
	run: mypy src/

	test:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: actions/setup-python@v5
	with:
	python-version: "3.11"
	- name: Install dependencies
	run: pip install -e ".[dev]"
	- name: Run tests
	run: pytest --cov-report=xml
	- name: Upload coverage
	uses: codecov/codecov-action@v4
	with:
	file: ./coverage.xml
	fail_ci_if_error: false

Provide feedback