Skip to content

docs: flesh out README with usage, badges, and docs links#23

Merged
maastrich merged 1 commit intomainfrom
docs/readme
Apr 24, 2026
Merged

docs: flesh out README with usage, badges, and docs links#23
maastrich merged 1 commit intomainfrom
docs/readme

Conversation

@maastrich
Copy link
Copy Markdown
Owner

Summary

  • Replace the placeholder README with a standard OSS-style readme: tagline, feature list, install + requirements, library and CLI usage examples, and links to the GitHub Pages docs.
  • Add status/size/download badges (npm version, monthly downloads, bundlephobia minzip, packagephobia install size, license, supported Node version, GitHub stars).
  • Add a brief contributing section pointing at vp and AGENTS.md.

Test plan

🤖 Generated with Claude Code

Replace the placeholder README with a standard OSS-style readme: project
pitch, feature list, install/requirements, library + CLI usage, a set of
status/size/download badges, and links to the GitHub Pages docs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

📖 Docs preview: https://maastrich.github.io/hashup/branches/pr-23/

@maastrich maastrich merged commit 38a5bb3 into main Apr 24, 2026
3 checks passed
@maastrich maastrich deleted the docs/readme branch April 24, 2026 15:09
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