Skip to content

docs: revise README - #1535

Merged
avoidwork merged 2 commits into
mainfrom
docs/README-revised
Oct 25, 2026
Merged

avoidwork merged 2 commits into
mainfrom
docs/README-revised

Conversation

@avoidwork

@avoidwork avoidwork commented Oct 25, 2026 •

Copy link
Copy Markdown
Owner

Summary

Revises the project README to tighten the front door and add proof of the agent in action.

Changes

  • Reordered sections: the persona table moved below the pitch and differentiator, so the substance leads and the personality is the reward for scrolling.
  • Merged the redundant Why Madz and Use Cases sections — the security/regulated bullets were duplicated, now folded into a single closing line.
  • Added a See it work section with an illustrative SSH transcript, addressing the missing proof of the agent doing anything.
  • Broke the run-on How It Works paragraph into three bullets matching the diagram's columns.
  • Trimmed the persona prose while keeping the character table intact.

Testing

N/A — documentation-only change.

Coverage

Maintained — no source changes.

Checklist

  • Follows repo conventions (AGENTS.md §5.1, §5.2, §5.4)
  • Documentation-only, no source impact
  • PR body matches template

@avoidwork avoidwork self-assigned this Oct 25, 2026
@avoidwork
avoidwork force-pushed the docs/README-revised branch from c4f7b6c to 8e72288 Compare October 25, 2026 20:17
@avoidwork avoidwork changed the title docs: add revised README draft docs: revise README Oct 25, 2026
@avoidwork
avoidwork merged commit f5a5875 into main Oct 25, 2026
2 checks passed
@avoidwork
avoidwork deleted the docs/README-revised branch October 25, 2026 20:26
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