Skip to content

Rewrite root README with a complete, accurate example catalog - #68

Draft
NikhilShahi wants to merge 1 commit into
mainfrom
cursor/update-root-readme-e3f8
Draft

Rewrite root README with a complete, accurate example catalog#68
NikhilShahi wants to merge 1 commit into
mainfrom
cursor/update-root-readme-e3f8

Conversation

@NikhilShahi

Copy link
Copy Markdown

The root README was a generic placeholder: wrong clone URL (your-org/...), Node 16+, claims of tests and a LICENSE file that did not exist, and no index of the 46 apps.

This replaces it with a README that matches what is actually in the repo.

What changed

  • Correct clone URL: github.com/hyperbrowserai/hyperbrowser-app-examples
  • Table of contents, prerequisites, and a standard Next.js quick start
  • All 46 standalone apps, grouped by use case, with a one-line description and typical API keys
  • “How to pick an example” table (Live View, Computer Use, sandboxes, swarms, DESIGN.md, etc.)
  • Run notes for the outliers: ChurnHunter CLI, Hyperplex (Docker + worker), Agent Web Index harness, UI-entered keys, o5-automation preflight
  • Honest env-file conventions (templates are inconsistent; many READMEs reference a missing .env.example)
  • Hyperbrowser capability map (scrape, Live View, Computer Use, sandboxes, volumes)
  • Deployment caveats (serverless timeouts, cost, local public/runs/ disk)
  • Real support links only (docs, dashboard, Node SDK, issues, @hyperbrowser)
  • Root MIT LICENSE so the license section and badge are valid (three apps already shipped MIT)

What I did not invent

  • No Discord/community link (none exists in-repo)
  • No claim that every app is production-ready or has tests
  • Node guidance is 20.9+ recommended (Next.js 16); 18.18+ for older Next 14/15 apps

Each app still has its own README for setup details. This file is the index and the shared getting-started guide.

Open in Web Open in Cursor 

Replace the generic overview with an accurate guide: correct clone URL,
Node 20+ guidance, all 46 standalone apps grouped by use case, env and
run conventions, and real Hyperbrowser resource links. Add the MIT
LICENSE the README already claimed.

Co-authored-by: Nikhil Shahi <nshahi1998@gmail.com>
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