chore: update readme! (#96) #2

	name: Deploy MkDocs

	on:
	push:
	branches:
	- main # Trigger deployment on pushes to main
	paths:
	- 'docs/**'
	- 'mkdocs.yml'

	jobs:
	deploy:
	runs-on: ubuntu-latest

	steps:
	- name: Checkout repository
	uses: actions/checkout@v3

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

	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install mkdocs mkdocs-material

	- name: Build the documentation
	run: mkdocs build

	- name: Deploy to GitHub Pages
	uses: peaceiris/actions-gh-pages@v3
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: ./site

Provide feedback