Skip to content

docs: update README with npm badge, installation, and project status#21

Merged
evansantos merged 2 commits intomainfrom
docs/update-readme
Feb 19, 2026
Merged

docs: update README with npm badge, installation, and project status#21
evansantos merged 2 commits intomainfrom
docs/update-readme

Conversation

@evansantos
Copy link
Copy Markdown
Owner

@evansantos evansantos commented Feb 19, 2026

Updates README to reflect current state:

  • npm badges (version, CI, license)
  • npm install as primary installation method
  • ClawRouter routing in feature list
  • Status section (v0.1.0, observation mode, 9 open issues, 8 merged PRs)
  • Contributing section with branch protection note

🐕 GitSniff Summary

What this PR does

This pull request enhances the project's README documentation to provide a more accurate and comprehensive overview for new and existing users. It updates installation instructions, details recent feature integrations like ClawRouter, and includes current project metrics such as version status, open issues, and merged pull requests, thereby improving project transparency and ease of setup.

Key Changes

  • Add npm version, CI, and license badges to the README.md.
  • Update the primary installation method to use npm install.
  • Highlight ClawRouter integration in the features list for intelligent model routing.
  • Include a 'Status' section detailing the current version, observation mode, active mode blockers, and project issue/PR statistics.
  • Add a 'Contributing' section with instructions for developers to get started.
  • Remove the 'Coming Soon' section.

Review Score: Excellent 🟢

Tip

No major issues found. Safe to merge.

Open in Dashboard

🐕 Reviewed by GitSniff

- Add npm version, CI, and license badges
- Add npm install as primary installation method
- Add routing to feature list
- Add Status section with current version, mode, and links
- Add Contributing section
- Update description to mention ClawRouter integration
Copy link
Copy Markdown

@gitsniff gitsniff bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Score: Excellent

The PR updates the README.md file to reflect the current state of the SlimClaw project. It adds npm badges, clarifies installation methods, updates the feature list to include intelligent model routing, provides a project status section, and adds contributing guidelines. The changes are largely documentation-focused and improve the clarity and accuracy of the project's README.

2 findings posted as inline comments below.

Review completed in 43s | Basic Plan | Gemini 2.5 Flash

README.md Outdated

Token optimization plugin for OpenClaw. Tracks cache hits, measures savings, provides real-time metrics, and integrates intelligent model routing via [ClawRouter](https://github.com/BlockRunAI/clawrouter).

**422 tests passing** · **0 vulnerabilities** · **Node 22+**
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Warning

The line **422 tests passing** is a hardcoded value. This can quickly become outdated as tests are added, removed, or fail, leading to an inaccurate representation of the project's test status.

Fix: Replace the hardcoded test count with a dynamic badge that reflects the current test status from the CI pipeline. This ensures the README always displays accurate and up-to-date information.

Suggested change
**422 tests passing** · **0 vulnerabilities** · **Node 22+**
![Tests](https://github.com/evansantos/slimclaw/actions/workflows/ci.yml/badge.svg?branch=main) <!-- Or a more specific test badge if available --> · **0 vulnerabilities** · **Node 22+**


## Contributing

PRs welcome! The project uses branch protection — all changes go through PR with CI + [GitSniff](https://gitsniff.ai) review.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ Info

The mention of 'GitSniff review' is ambiguous. While it accurately describes the current review process, it might not be clear to external contributors what GitSniff is or how it functions within the PR workflow. This could lead to confusion about the review expectations.

Fix: Consider briefly explaining GitSniff's role (e.g., 'automated AI code review') or linking to its documentation if available. This provides clarity for new contributors and maintains transparency in the review process.

Suggested change
PRs welcome! The project uses branch protection — all changes go through PR with CI + [GitSniff](https://gitsniff.ai) review.
PRs welcome! The project uses branch protection — all changes go through PR with CI + automated AI code review by [GitSniff](https://gitsniff.ai).

GitSniff warning — hardcoded test counts get outdated quickly.
@evansantos
Copy link
Copy Markdown
Owner Author

GitSniff findings addressed:

Copy link
Copy Markdown

@gitsniff gitsniff bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Score: Excellent

The PR updates the README.md file to better reflect the current state of the SlimClaw project. It adds npm badges, clarifies installation methods, highlights ClawRouter integration, and provides a status overview including open issues and merged PRs. Overall, the changes improve the documentation's accuracy and completeness.

✅ No issues found. Ready to merge!

Review completed in 22s | Basic Plan | Gemini 2.5 Flash

@evansantos evansantos merged commit 1075701 into main Feb 19, 2026
6 checks passed
@evansantos evansantos deleted the docs/update-readme branch February 19, 2026 23:13
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