Skip to content

Update README.md for improved installation and usage instructions#1

Merged
damiant merged 1 commit into
mainfrom
readme
Nov 17, 2025
Merged

Update README.md for improved installation and usage instructions#1
damiant merged 1 commit into
mainfrom
readme

Conversation

@damiant
Copy link
Copy Markdown
Contributor

@damiant damiant commented Nov 17, 2025

This pull request updates the README.md to provide clearer installation instructions and more comprehensive documentation for using the Builder.io Dev-tools with Homebrew. The changes focus on improving usability for new users and clarifying the available commands and installation methods.

Documentation and usability improvements:

  • Added a dedicated "Installation" section with explicit instructions for installing via Homebrew, including a code example for the command.
  • Introduced a "Usage" section detailing how to use the CLI, including a link to external documentation for further reference.
  • Added an "Examples" section showing sample commands for common tasks with the CLI.
  • Provided additional information about Homebrew, including links to its documentation and help commands.
  • Clarified alternative installation methods and improved the Brewfile example for bundling the tap and formula.

@damiant damiant requested a review from STRd6 November 17, 2025 20:23
Copy link
Copy Markdown
Contributor

@STRd6 STRd6 left a comment

Choose a reason for hiding this comment

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

Thanks!

@damiant damiant merged commit a86ae15 into main Nov 17, 2025
1 of 4 checks passed
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