synapse/goatcounter-stats-gateway
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions

docs: npm package README #13

Merged
synapse merged 1 commit from docs/npm-readme into develop 2026-08-21 20:49:50 +00:00
Conversation 0 Commits 1 Files changed 2 +94 -1
synapse commented 2026-08-21 20:47:38 +00:00
Owner
Copy link

The npm package page was bare — the published tarball had no README. Adds clients/ts/README.md written in package language (install incl. CDN path, headless usage with the Result type, element attributes, full styling interface) and includes it in the flake-built package.

Note: npmjs renders it with the next published version — READMEs are per-version, so the page updates when the next gateway tag publishes (npm's edit-README-without-republish does not exist).

🤖 Generated with Claude Code

https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9

The npm package page was bare — the published tarball had no README. Adds clients/ts/README.md written in package language (install incl. CDN path, headless usage with the Result type, element attributes, full styling interface) and includes it in the flake-built package. Note: npmjs renders it with the next *published version* — READMEs are per-version, so the page updates when the next gateway tag publishes (npm's edit-README-without-republish does not exist). 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9
docs: package README for the npm page
All checks were successful
ci / gate (pull_request) Successful in 16s
Details
b259f6e5b9
 
clients/ts/README.md — written for a JS dev landing on npmjs (install,
headless usage, element attributes + styling interface), not the
gateway's architecture story. Included in the published package via the
flake build; appears on npm with the next released version.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01T5j3dAJVcUjZv9k76sRTt9
synapse merged commit 77b081a73d into develop 2026-08-21 20:49:50 +00:00
synapse deleted branch docs/npm-readme 2026-08-21 20:49:50 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
synapse/goatcounter-stats-gateway!13
No description provided.