docs: add logo for project, expand readme (#7)
All checks were successful
CI / Makefile Lint (push) Successful in 22s
CI / Go Lint (push) Successful in 26s
CI / Markdown Lint (push) Successful in 9s
CI / Unit Tests (push) Successful in 21s
CI / Fuzz Tests (push) Successful in 53s
CI / Mutation Tests (push) Successful in 1m23s

Reviewed-on: #7
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>
This commit was merged in pull request #7.
This commit is contained in:
2026-03-21 01:14:17 +00:00
committed by Maxim Hutz
parent 56b1982f8a
commit e00e6fcb1b
8 changed files with 40 additions and 4 deletions

View File

@@ -1,4 +1,4 @@
.PHONY: all help install clean test-unit test-mutation test-fuzz test docs lint-go lint-makefile lint
.PHONY: all help install clean test-unit test-mutation test-fuzz test docs lint-go lint-makefile lint-markdown lint
help: ## Show this help
@grep -E '^[a-zA-Z_-]+:.*##' $(MAKEFILE_LIST) | awk -F ':.*## ' '{printf " %-15s %s\n", $$1, $$2}'
@@ -32,7 +32,10 @@ lint-go: ## Lint Go code
lint-makefile: ## Lint the Makefile
checkmake Makefile
lint: lint-go lint-makefile ## Lint all code
lint-markdown: ## Lint Markdown files
docker run --rm -v $(CURDIR):/workdir davidanson/markdownlint-cli2 "**/*.md"
lint: lint-go lint-makefile lint-markdown ## Lint all code
docs: ## Serve godoc locally
@echo ">>> Visit: http://localhost:6060/pkg/$$(go list -m)"