updated readme, doc comments, and logging items (#16) #14

	name: main-build
	on:
	push:
	branches:
	- main

	jobs:
	build:
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v4
	- name: Setup
	uses: actions/setup-go@v4
	with:
	go-version: '1.21.x'
	- name: Install dependencies
	run: go get .
	- name: Build
	run: go build -v ./...
	- name: Test
	run: \|
	go test -v ./... -covermode=count -coverprofile=coverage.out
	go tool cover -func=coverage.out -o=coverage.out

Provide feedback