Skip to content

docs: hero README and demo walkthrough - #4

Closed
jordanpartridge wants to merge 3 commits into
mainfrom
cursor/hero-readme-demo-6412
Closed

jordanpartridge wants to merge 3 commits into
mainfrom
cursor/hero-readme-demo-6412

Conversation

@jordanpartridge

Copy link
Copy Markdown
Contributor

Summary

Showcasable README and demo docs for the Cloudflare CLI.

  • Product-style hero README with badges, install, commands, architecture, agent --json callout
  • docs/demo.md walkthrough and sample terminal session
  • CI workflow (PHP 8.3 + Pest)
  • MIT LICENSE

Test plan

  • CI green on this PR
  • Skim README render on GitHub
Open in Web Open in Cursor 

cursoragent and others added 3 commits September 9, 2026 22:52
Elevate the README into a product showcase for the Conduit Cloudflare
CLI (cf), add a zones→DNS→tunnel demo script with sample terminal
output, add MIT LICENSE, and add minimal Pest CI for main and cursor
branches.

Co-authored-by: Jordan Partridge <jordan@partridge.rocks>
composer.lock resolves Symfony 8 which requires PHP >=8.4.1; keep the
minimal workflow shape but use 8.4 so composer install and pest succeed.

Co-authored-by: Jordan Partridge <jordan@partridge.rocks>
The 8.4 CI bump was only needed before main pinned composer to PHP 8.3.
@jordanpartridge
jordanpartridge force-pushed the cursor/hero-readme-demo-6412 branch from 2d22c36 to f3b3683 Compare September 10, 2026 05:52

@lexi-chief-of-staff lexi-chief-of-staff Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ship it.

  • Docs-only change; no runtime paths touched.
  • README now matches the Conduit agent surface described in the PR body.
  • demo.md / demo.cast.md give reproducible walkthroughs without requiring live API calls.
  • License addition is standard MIT and matches the 2026 copyright already in the repo. No further action needed.

jordanpartridge added a commit that referenced this pull request Sep 10, 2026
PR #5 must not claim docs/agent-output.md or the {ok,data} envelope
(that is unmerged #7). Fold demo.md / demo.cast.md from #4; leave
the hero README crew and PHAR install alone.
@jordanpartridge

Copy link
Copy Markdown
Contributor Author

Closing as leftover from the Cursor batch.

If you still want the hero README tone, fold it into #5 after that rebases.

cursor Bot pushed a commit that referenced this pull request Sep 13, 2026
PR #5 must not claim docs/agent-output.md or the {ok,data} envelope
(that is unmerged #7). Fold demo.md / demo.cast.md from #4; leave
the hero README crew and PHAR install alone.
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.

2 participants