Skip to content

docs: polish README + add SECURITY.md#19

Merged
wavyx merged 1 commit into
mainfrom
docs/readme-polish-security
Jun 16, 2026
Merged

docs: polish README + add SECURITY.md#19
wavyx merged 1 commit into
mainfrom
docs/readme-polish-security

Conversation

@wavyx

@wavyx wavyx commented Jun 16, 2026

Copy link
Copy Markdown
Owner

Brings the README to hscli's level of polish and adds a security policy.

  • Badges 3 → 7 (npm version, CI, codecov, downloads, Node, MIT, Docs)
  • Commands table indexing all ~30 topics (was none)
  • Coverage paragraph + docs link moved under the intro
  • Footer parity: Documentation + Contributing sections; License links LICENSE © Eric Rodriguez
  • Install annotates Node 20+
  • New SECURITY.md: private vulnerability reporting + the keychain-only / host-locked / no-redirect credential model

Docs-only; no code or behavior changes.

…TY.md

- Badges: 3 → 7 (npm version first, + downloads, Node, MIT, Docs), matching hscli.
- New Commands table indexing all ~30 topics at a glance.
- Coverage paragraph (v2 core + v1 domains + analytics/sync/backup) and the
  docs link moved up under the intro.
- Footer parity: Documentation + Contributing sections; License now links
  LICENSE with attribution.
- Install annotates Node 20+.
- New SECURITY.md: private reporting + the keychain-only / host-locked /
  no-redirect credential model.
@wavyx wavyx merged commit c4e55ed into main Jun 16, 2026
11 checks passed
@wavyx wavyx deleted the docs/readme-polish-security branch June 16, 2026 07:14
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

2 participants