update readme and make workflow work #1

	name: website

	# build the documentation whenever there are new commits on main
	on:
	push:
	branches:
	- master
	# Alternative: only build for tags.
	# tags:
	# - '*'

	# security: restrict permissions for CI jobs.
	permissions:
	contents: read

	jobs:
	setup:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: actions/setup-python@v4
	with:
	python-version: '3.9'
	cache: 'pip'
	# ADJUST THIS: install all dependencies (including pdoc)
	#- run: pip install -e .
	- run: pip install -e ".[all]"
	- run: pip install pdoc

	# run unit tests
	# - run: pytest -vv

	# ADJUST THIS: build your documentation into docs/.
	# We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
	- run: pdoc src -o docs/ --docformat numpy
	- uses: actions/upload-pages-artifact@v2
	with:
	path: docs/

	# Deploy the artifact to GitHub pages.
	# This is a separate job so that only actions/deploy-pages has the necessary permissions.
	deploy:
	needs: setup
	runs-on: ubuntu-latest
	permissions:
	pages: write
	id-token: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- id: deployment
	uses: actions/deploy-pages@v2

Provide feedback