Readme + types (#2) #13

	# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
	# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions

	name: Tests

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

	jobs:
	test:
	name: Unit tests
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- name: Use Node.js
	uses: actions/setup-node@v4
	with:
	cache: 'npm'
	- name: Install dependencies
	run: npm install --ignore-scripts --no-audit --no-fund
	- name: Unit tests
	run: npm test
	- name: Check types
	run: npm run check
	- name: Lint JS
	run: npx oxlint@latest -D perf
	- name: Build package
	run: npm run build
	env:
	CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
	- name: 'Publint'
	run: 'npx --yes publint'
	- name: Upload coverage reports to Codecov
	uses: codecov/[email protected]
	with:
	token: ${{ secrets.CODECOV_TOKEN }}

Provide feedback