Skip to content

docs: add Quick Example section to README (closes #2) - #5

Merged
rockywuest merged 2 commits into
masterfrom
docs/usage-examples
Apr 24, 2026
Merged

rockywuest merged 2 commits into
masterfrom
docs/usage-examples

Conversation

@rockywuest

Copy link
Copy Markdown
Owner

What

Adds a concrete Before/After block + auto-capture flow explanation to the README, addressing #2.

Why

Issue #2 noted: README is structured but lacks concrete usage examples → hard to visualize value.

What I skipped

  • Screenshots: requires running OpenClaw with private workspace context. Text example covers the same ground.
  • Custom code snippets: the auto-capture flow diagram is more useful than fake API calls (plugins are event-driven, not directly invoked).

CI

Lint, format, all 11 test files green (verified locally with the new --test-force-exit fix from PR #4).

Adds a concrete Before/After demonstration of what the plugins enable,
plus a brief explanation of the auto-capture flow.

Skips screenshots for now (requires running OpenClaw + private workspace
context). The textual example covers the same ground.

Closes #2
@rockywuest
rockywuest merged commit 84cabb9 into master Apr 24, 2026
2 checks passed
@rockywuest
rockywuest deleted the docs/usage-examples branch April 24, 2026 10:20
rockywuest added a commit that referenced this pull request Oct 17, 2026
* docs: add Quick Example section to README (closes #2)

Adds a concrete Before/After demonstration of what the plugins enable,
plus a brief explanation of the auto-capture flow.

Skips screenshots for now (requires running OpenClaw + private workspace
context). The textual example covers the same ground.

Closes #2

* docs: prettier autoformat
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