docs: document some of the main features #267

	---
	name: Build, test and lint

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


	jobs:
	build-test-lint:
	runs-on: ubuntu-latest

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

	- name: Install Go
	uses: actions/setup-go@v5
	with:
	go-version: '^1.23.2'

	- name: Install tools
	run: make deps-tools

	- name: Build
	run: make build

	- name: Lint
	run: make lint

	- name: Tidy dependencies
	run: make deps-tidy

	- name: Run tests
	run: make test

	- name: Require clean working directory
	shell: bash
	run: \|
	if ! git diff --exit-code; then
	echo "Working tree dirty at end of job"
	exit 1
	fi

Provide feedback