fix: small bugs and update the readme with the new documentation #17

	name: CI

	on:
	push:
	branches: [main]
	pull_request:
	branches: [main]

	# Cancel in-progress runs when a new push is made
	concurrency:
	group: ${{ github.workflow }}-${{ github.ref }}
	cancel-in-progress: true

	jobs:
	lint-and-build:
	name: Lint, Format Check & Build
	runs-on: ubuntu-latest
	timeout-minutes: 10

	steps:
	- name: Checkout code
	uses: actions/checkout@v4

	- name: Setup Node.js
	uses: actions/setup-node@v4
	with:
	node-version: '24'
	cache: 'npm'

	- name: Install dependencies
	run: npm ci

	- name: Check formatting
	run: npx prettier --check src

	- name: TypeScript build
	run: npm run build

	- name: Check for build artifacts
	run: \|
	if [ ! -d "dist" ]; then
	echo "Error: dist directory not created"
	exit 1
	fi
	echo "Build successful!"

	# Only run dependency audit on main branch pushes to save minutes
	security:
	name: Security Audit
	runs-on: ubuntu-latest
	if: github.event_name == 'push' && github.ref == 'refs/heads/main'
	timeout-minutes: 5

	steps:
	- name: Checkout code
	uses: actions/checkout@v4

	- name: Setup Node.js
	uses: actions/setup-node@v4
	with:
	node-version: '20'
	cache: 'npm'

	- name: Install dependencies
	run: npm ci

	- name: Run security audit
	run: npm audit --audit-level=moderate
	continue-on-error: true

Navigation Menu