Fundamental instructions missing from documentation
See original GitHub issueOn both the readme and the site, these are the instructions:
Getting Started
Install the BundleWatch package:
- NPM:
npm install bundlewatch --save-dev
- Yarn:
yarn add bundlewatch --dev
Add some basic configuration to your
package.json
{ "name": "my package name", "version": "0.0.1", "bundlewatch": { "files": [ { "path": "myfolder/*.js", "maxSize": "100kB" } ] } }
Usage:
- NPM:
npm run bundlewatch
- Yarn:
yarn run bundlewatch
This will give you command line output. If you want BundleWatch to report build status on your pull requests, see below.
Now run the last command:
❯ npm run bundlewatch
npm ERR! missing script: bundlewatch
Issue Analytics
- State:
- Created 3 years ago
- Reactions:4
- Comments:6
Top Results From Across the Web
Auditing Standard No. 3 - PCAOB
This standard establishes general requirements for documentation the auditor should prepare and retain in connection with engagements conducted pursuant to ...
Read more >Importance of Documentation | The Workstream - Atlassian
Effective documentation collects all of the must-know information about a task, project, or team (from account logins to step-by-step instructions) in a ...
Read more >Good documentation practice in clinical research - PMC - NCBI
Irrespective of clinical trial, accurate documentation supports the fundamental principle of protecting subject's rights, safety and well-being.
Read more >How to Write Work Instructions That Are Easy to Follow
In this post, you'll learn how to develop work instructions that work! ... cause confusion, and result in workers missing essential steps.
Read more >Rules for the Accessibility Checker - Microsoft Support
Document access is not restricted. Any document that has disabled the Access content programmatically option in the document permissions settings: Review > ...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
It would also be super nice if the format of the
.json
file provided to--config
were documented.And also that before the PR Action starts working, it needs to be pushed to the default branch, otherwise you get this when trying to add it in a PR: