Fundamental instructions missing from documentation

[fregante]

On 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

[fregante]

Also on the "Using bundlewatch" page nowhere does it say how and where to make the GitHub App work.

I assume that this piece information is missing:

In your CI that runs in every PR, run npm run bundlewatch after your build. For example on GitHub Actions:

      - uses: actions/checkout@v2
      - run: npm ci
      - run: npm run build
      - run: npm run bundlewatch
        env:
          BUNDLEWATCH_GITHUB_TOKEN: 8fc08494d51041a393beb

[fregante]

And also the fundamental information that the token is actually a secret and should not be public.

[fregante]

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:

[INFO] Retrieving comparison
Error:  Unable to fetch fileDetails for baseBranch=master from https://service.bundlewatch.io/store code=Request failed with status code 404
[INFO] master !== bundlewatch, no results saved
[INFO] bundlewatch is not a branch to track, no results saved

[einSelbst]

Thank you @fregante! I was about to give up on this but have it now working to some extend. There is also that https://github.com/jackyef/bundlewatch-gh-action but I couldn't get it to work.

[aqueiros]

Also, this information is misleading

Setup CI Variables Needed by BundleWatch:
The most efficient way to get this running is to ensure that some environment variables are available for BundleWatch to find.

CI_REPO_OWNER github.com/facebook/react
CI_REPO_NAME github.com/facebook/react
CI_COMMIT_SHA
CI_BRANCH
If you're using, Travis, CircleCI, Wrecker or Drone these should all work out of the box.

I am using Travis and I have no such variables. Definitely none prefixed with "CI". Also not according to Travis:
https://docs.travis-ci.com/user/environment-variables/#default-environment-variables

UPDATE: I now see that internally it uses some library called ci-env which abstracts fetching these env vars from many different CI services. This should be better explained anyhow as it made me lose much time

[rogersd]

It would also be super nice if the format of the .json file provided to --config were documented.