Skip to content

docs: refresh README with crates.io install, config reference, badges#25

Merged
moutons merged 2 commits intomainfrom
docs/readme-refresh
Apr 21, 2026
Merged

docs: refresh README with crates.io install, config reference, badges#25
moutons merged 2 commits intomainfrom
docs/readme-refresh

Conversation

@moutons
Copy link
Copy Markdown
Owner

@moutons moutons commented Apr 20, 2026

Summary

  • Lead with what the project does, not what it reimplements
  • Installation favors cargo binstall / cargo install from crates.io
  • Add Quick Start section for immediate usability
  • Document full configuration system: config file, all sections/fields with defaults, environment variable mapping, override order
  • Add crates.io version and OpenSSF Best Practices badges
  • Move Python library inspiration to Background section at end

Test plan

  • README renders correctly on GitHub
  • All links are valid
  • Config documentation matches skills-validator setup output

🤖 Generated with Claude Code

claude-bot and others added 2 commits April 20, 2026 04:34
- Lead with what the project does, not what it reimplements
- Installation favors crates.io over building from source
- Add Quick Start section
- Document full configuration system: config file, all sections/fields,
  environment variable mapping, override order
- Add crates.io and OpenSSF Best Practices badges
- Move Python inspiration note to Background section at end

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@moutons moutons merged commit 03f449e into main Apr 21, 2026
11 checks passed
@moutons moutons deleted the docs/readme-refresh branch April 21, 2026 06:15
@github-actions github-actions Bot mentioned this pull request Apr 21, 2026
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