Skip to content

Latest commit

 

History

History
31 lines (17 loc) · 1.18 KB

README.md

File metadata and controls

31 lines (17 loc) · 1.18 KB

NPM version NPM dependencies

Budgie

A tool to help build a website's PerfLint performance budget.

Install

npm install -g budgie

Usage

Run the following in your terminal;

budgie

Available Options

-h, --help Displays available options.

-v, --version Displays version.

-o, --output Output path of the generated PerfLint config. Defaults to stdout.

-t, --timeout Define the timeout of WebPageTest requests.

Further Reading

The categories for metrics are based on Tim Kadlec's brilliant article on performance budgets.

The generated configurations are only rough guides, to add your own metrics see the PerfLint Rules documentation for available metrics. For further configuration options see the Configuring PerfLint documentation.