Repository navigation
[docs] README.md is outdated — update installation, usage, and feature list #305
Description
Context
The current README.md (4.6 KB) does not reflect the current CLI commands, finding codes, or output formats. Installation instructions reference an older toolchain.
What to update
- Installation:
cargo install sanctifier-cliand from source - Quick start: single command example showing
sanctifier analyze ./contracts - Features table: list all 11 finding codes with one-line descriptions
- CLI reference:
analyze,init,deploy,badge,updatewith flags - Screenshot or example JSON output
Acceptance criteria
- All commands in README are tested and work as described
- No references to features not yet implemented
- Badges: CI status, Codecov coverage, crates.io version
Activity
itsjaneossai commentedon Mar 24, 2026
@itsjaneossai has applied to work on this issue as part of the Stellar Wave Program's 3rd wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @itsjaneossai to this issue.
Jayy4rl commentedon Mar 24, 2026
@Jayy4rl has applied to work on this issue as part of the Stellar Wave Program's 3rd wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @Jayy4rl to this issue.
drips-wave commentedon Mar 24, 2026
Congratulations, @Jayy4rl! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on March 30, 2026.
🧑💻 @Jayy4rl: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.
Warning
When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.
🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.
🌊 Happy Wave 🌊
docs: update README.md and error-codes.md for issue HyperSafeD#305\n\…
Merge pull request #355 from Jayy4rl/docs/update-readme-305
docs: update README.md and error-codes.md for issue #305\n\n- Add CI …
fix: harden CLI input validation, add callgraph/logging/deploy tests,…
drips-wave commentedon Jun 28, 2026
This issue has been completed by @Jayy4rl as part of the Stellar Wave Program's 6th Wave 🥳
😎 @Jayy4rl: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.
🧑💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.
fix: harden CLI input validation, add callgraph/logging/deploy tests,…
fix: harden CLI input validation, add callgraph/logging/deploy tests,…
fix: harden CLI input validation, add callgraph/logging/deploy tests,…