Skip to content

[EVI-12]: shorten evidence README#43

Merged
sunnypurewal merged 1 commit into
mainfrom
claude/evi-12-shorten-readme
May 20, 2026
Merged

[EVI-12]: shorten evidence README#43
sunnypurewal merged 1 commit into
mainfrom
claude/evi-12-shorten-readme

Conversation

@riddim-developer-bot
Copy link
Copy Markdown
Contributor

Summary

  • Cuts the root README from 375 lines / 1,765 words to 161 lines / 565 words.
  • Keeps the README focused on purpose, quick start, minimal app usage, command overview, one CI example, safety guidance, and links.
  • Leaves detailed command and launch material in docs/ and Examples/ instead of duplicating it in the root README.

Review basis

Sampled GitHub's README guidance plus public README patterns from React, VS Code, freeCodeCamp, and Oh My Zsh. The applied pattern is: short front door, quick path to first use, links to deeper docs.

Verification

  • wc -l README.md && wc -w README.md -> 161 lines, 565 words.
  • swift run evidence -- --help passed and README command references match the exposed CLI surface.
  • git diff --check origin/main..HEAD passed.
  • README stale/internal scan returned no matches for removed commands, internal runner labels, local paths, or private Riddim repo references.
  • swift test --filter WorkflowSafetyTests passed: 3 tests, 0 failures.

Follow-up to EVI-12 / PR #42.

@riddim-developer-bot riddim-developer-bot Bot added the autonomous Autonomous agent PR label May 20, 2026
@sunnypurewal sunnypurewal merged commit e76e799 into main May 20, 2026
4 checks passed
@sunnypurewal sunnypurewal deleted the claude/evi-12-shorten-readme branch May 20, 2026 05:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autonomous Autonomous agent PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant