Update README with documentation #34

	# This workflow will install Python dependencies and run tests with a variety of Python versions
	# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

	name: Tests

	on:
	push:
	branches: [ "main" ]
	pull_request:
	types: [opened, reopened, synchronize]

	permissions:
	contents: read

	jobs:
	test:
	name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	python-version: ["3.8", "3.11"]
	os: [ubuntu-22.04]

	steps:
	# Checkout current git repository
	- name: Checkout
	uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2

	# Install Python
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@bd6b4b6205c4dbad673328db7b31b7fab9e241c0 # v4.6.1
	with:
	python-version: ${{ matrix.python-version }}

	# Install local package and dependencies from requirements.txt
	- name: Install package and Python dependencies
	run: \|
	python -m pip install --editable=.
	python -m pip list

	# Run the unit tests
	- name: Test with pytest
	run: python -m pytest --cov evalem --verbose tests/

Provide feedback