Rewrite root README with a complete, accurate example catalog - #68
Draft
NikhilShahi wants to merge 1 commit into
Draft
Rewrite root README with a complete, accurate example catalog#68NikhilShahi wants to merge 1 commit into
NikhilShahi wants to merge 1 commit into
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
github.com/hyperbrowserai/hyperbrowser-app-exampleso5-automationpreflight.env.example)public/runs/disk)LICENSEso the license section and badge are valid (three apps already shipped MIT)What I did not invent
Each app still has its own README for setup details. This file is the index and the shared getting-started guide.