Skip to content

Add project README - #24

Merged
antonisloukis merged 1 commit into
mainfrom
docs/professional-readme
Aug 4, 2026
Merged

antonisloukis merged 1 commit into
mainfrom
docs/professional-readme

Conversation

@antonisloukis

Copy link
Copy Markdown
Owner

Summary

Replaces the minimal README with complete project documentation for RunbookProof.

Changes

  • Added a clear project overview and problem statement
  • Added CI and Code Scanning workflow badges
  • Documented installation and quick-start commands
  • Documented file and directory scanning
  • Documented text, JSON, and SARIF output
  • Documented -o and --output
  • Listed all built-in verification packs
  • Documented process exit codes
  • Added GitHub Code Scanning integration example
  • Added architecture overview
  • Added development and validation commands
  • Added roadmap, security model, and license sections
  • Clarified the current pre-alpha project status

Validation

  • RunbookProof scanned the new README
  • 899 tests passed
  • Total coverage: 93.25%
  • Ruff formatting check passed
  • Ruff linting passed
  • MyPy passed
  • git diff --check passed

@antonisloukis
antonisloukis merged commit 2e10b68 into main Aug 4, 2026
7 checks passed
@antonisloukis
antonisloukis deleted the docs/professional-readme branch August 4, 2026 13:33
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