Skip to content

Rewrite the README around the fork and mention it in doc.go - #29

Merged
avgvi merged 3 commits into
masterfrom
docs/readme-rewrite
Oct 11, 2026
Merged

avgvi merged 3 commits into
masterfrom
docs/readme-rewrite

Conversation

@avgvi

@avgvi avgvi commented Oct 11, 2026

Copy link
Copy Markdown
Member

Restructures the README so the first screen says what the fork is and why it exists, then quick start, migration (with the four behaviour changes in an alert box), one snippet per feature, a table of what v1.4.1 fixes with upstream links, compatibility, project status and credits. The original walkthrough is kept in a collapsed block.

Every Go block in the README was extracted and compiled against this branch (go vet and go build clean). The GitHub Markdown API renders the alerts, the three tables and the details block; all badge URLs return 200. The Go Report Card badge was left out because the service now reports itself as retired.

The package doc comment gains a sentence naming the fork and pointing to the README and changelog, which closes the Phase 6 pkg.go.dev task.

@avgvi
avgvi merged commit 536dfbd into master Oct 11, 2026
7 checks passed
@avgvi
avgvi deleted the docs/readme-rewrite branch October 11, 2026 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant