docs: add project readme #2

	#this workflow runs on every push and pull request, checks the code quality and runs the tests

	name: CI

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

	jobs:
	quality:
	name: code quality and tests
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- name: set up python
	uses: actions/setup-python@v5
	with:
	python-version: "3.12"

	- name: install dependencies
	run: pip install -e .[dev]

	- name: ruff - linting
	run: ruff check .

	- name: ruff - formatting
	run: ruff format --check .

	- name: mypy - type checking
	run: mypy app/

	- name: pytest - unit tests
	run: pytest

Provide feedback