Skip to content

Shorten the README - #8

Merged
pscheid92 merged 1 commit into
mainfrom
trim-readme
Nov 9, 2026
Merged

pscheid92 merged 1 commit into
mainfrom
trim-readme

Conversation

@pscheid92

Copy link
Copy Markdown
Owner

The README goes from 298 to about 200 lines.

  • Usage is two snippets instead of two full programs; the runnable versions are the examples on pkg.go.dev.
  • The differences from the format tag option are a table.
  • "How it is tested" is one paragraph, and the details moved to TESTING.md unchanged.
  • "Good to know" keeps what most readers need. Dropped from the README: the cmp.Or default for an empty Format
    (still an example) and the note on CanonicalizeRawInts (still in the package documentation).

The README had grown to about 300 lines. Usage is now two snippets
instead of two programs, the differences from the format tag option are
a table, and the details of the testing moved to TESTING.md.
@pscheid92
pscheid92 merged commit d5ebf4c into main Nov 9, 2026
19 checks passed
@pscheid92
pscheid92 deleted the trim-readme branch November 9, 2026 21:14
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