Skip to content

docs: make the README shorter - #12

Merged
pblobp merged 1 commit into
mainfrom
docs/concise-readme
Nov 18, 2026
Merged

pblobp merged 1 commit into
mainfrom
docs/concise-readme

Conversation

@pblobp

@pblobp pblobp commented Nov 18, 2026

Copy link
Copy Markdown
Owner

What changed and why

The repository README is half as long: 52 lines, down from 106.

  • Kept: the badges, the plugin table (its version now links to the plugin's page in Orca's directory), the cover, the four screenshots (in one table), the install command, a short security note, contributing and license.
  • Removed: the repository layout, the per-plugin access table and the Scorecard note. SECURITY.md, CONTRIBUTING.md, the docs and the plugin's own README already cover them.

The plugin's files do not change, so no new plugin version is needed.

Plugin

repository

Access changes

None

Tests

  • npm run check

Screenshots

The change is to the README itself.

🤖 Generated with Claude Code

https://claude.ai/code/session_01EWVANCgSt8W3VxxxZyAyoD

Half the length. It keeps the plugin table, the screenshots (now in
one table), the install command and a short security note, and links
to the directory page for OS Vitals. The repository layout, the access
table and the Scorecard note are gone; SECURITY.md, CONTRIBUTING.md
and the plugin's README already cover them.

Co-Authored-By: Claude Fable 5.2 <[email protected]>
Claude-Session: https://claude.ai/code/session_01EWVANCgSt8W3VxxxZyAyoD
@pblobp
pblobp merged commit 16907da into main Nov 18, 2026
9 checks passed
@pblobp
pblobp deleted the docs/concise-readme branch November 18, 2026 17:18
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