README update #148

	name: CI

	on:
	push:
	branches:
	- main
	tags:
	- "v*"
	pull_request:
	workflow_dispatch:

	jobs:
	# check-manifest:
	# runs-on: ubuntu-latest
	# steps:
	# - uses: actions/checkout@v3
	# - run: pipx run check-manifest

	test:
	name: ${{ matrix.platform }} (${{ matrix.python-version }})
	runs-on: ${{ matrix.platform }}
	strategy:
	fail-fast: false
	matrix:
	python-version: ['3.8', '3.9', '3.10', '3.11']
	platform: [ubuntu-latest, macos-latest, windows-latest]

	steps:
	- uses: actions/checkout@v3

	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v4
	with:
	python-version: ${{ matrix.python-version }}
	cache-dependency-path: "pyproject.toml"
	cache: "pip"

	# if running a cron job, we add the --pre flag to test against pre-releases
	- name: Install dependencies
	run: \|
	python -m pip install -U pip
	python -m pip install -e .[test]

	- name: Test
	run: pytest --color=yes #--cov --cov-report=xml --cov-report=term-missing

	# - name: Coverage
	# uses: codecov/codecov-action@v3

	deploy:
	name: Deploy
	needs: test
	if: success() && startsWith(github.ref, 'refs/tags/')
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v3

	- name: Set up Python
	uses: actions/setup-python@v4
	with:
	python-version: "3.x"

	- name: install
	run: \|
	git tag
	pip install -U pip build twine
	python -m build
	twine check dist/*
	ls -lh dist

	- name: Build and publish
	run: twine upload dist/*
	env:
	TWINE_USERNAME: __token__
	TWINE_PASSWORD: ${{ secrets.TWINE_API_KEY }}

	- uses: softprops/action-gh-release@v1
	with:
	generate_release_notes: true

Provide feedback