Change README.md to improve first time use - Githubissues

ModusCreateOrg / gimbal

Web Performance Auditing tooling

https://labs.moduscreate.com/gimbal-web-performance-audit-budgeting

MIT License

115 stars 8 forks source link

Change README.md to improve first time use #155

Closed rafaelbernard closed 4 years ago

rafaelbernard commented 4 years ago

Pull request checklist

Please check if your PR fulfills the following requirements:

[ ] Tests for the changes have been added (for bug fixes / features)
[ ] Docs have been reviewed and added / updated if needed (for bug fixes / features)
[ ] Build (npm run build:check or yarn build:check) was run locally and any changes were pushed
[ ] Lint (npm run lint or yarn lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, renaming)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[x] Documentation content changes
[ ] Other (please describe):

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Update README documentation to ease first time execution.

Does this introduce a breaking change?

[ ] Yes
[x] No

Other information