Fix docs and README (#62) #109

	name: Rust CI

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

	env:
	CARGO_TERM_COLOR: always

	jobs:
	rustfmt:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- name: Run rustmt
	run: cargo fmt --check

	test:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- name: Build
	run: cargo build --verbose
	- name: Run tests
	run: cargo test --verbose

	lint:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- name: Clippy check
	run: cargo clippy -- -D warnings

	coverage:
	runs-on: ubuntu-latest
	env:
	CARGO_TERM_COLOR: always
	steps:
	- uses: actions/checkout@v4
	- name: Install Rust
	run: rustup update stable
	- name: Install cargo-llvm-cov
	uses: taiki-e/install-action@cargo-llvm-cov
	- name: Generate code coverage
	run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
	- name: Upload coverage to Codecov
	uses: codecov/codecov-action@v3
	with:
	token: ${{ secrets.CODECOV_TOKEN }}
	files: lcov.info
	fail_ci_if_error: true

Provide feedback