feat: update readme (#36) #7

	name: Deploy docs to Github Pages

	on:
	# Runs on pushes targeting the default branch
	push:
	branches: ["main"]
	paths:
	- 'docs/**'
	- '!src/**'
	- '!test/**'
	- '!README.md'

	# Allows you to run this workflow manually from the Actions tab
	workflow_dispatch:

	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
	# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
	concurrency:
	group: "pages"
	cancel-in-progress: false

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	# fetch all commits to get last updated time or other git log info
	fetch-depth: 0

	- name: Setup pnpm
	uses: pnpm/action-setup@v4
	with:
	# choose pnpm version to use
	version: 9
	# install deps with pnpm
	run_install: true

	- name: Setup Node.js
	uses: actions/setup-node@v4
	with:
	# choose node.js version to use
	node-version: 20
	# cache deps for pnpm
	cache: pnpm

	# run build script
	- name: Build VuePress site
	run: pnpm docs:build

	- name: Setup Pages
	uses: actions/configure-pages@v5

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	# Upload entire repository
	path: 'docs/.vuepress/dist'

	deploy:
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	needs: build
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback