Skip to content

Commit

Permalink
Add tip about --no-optional (#625)
Browse files Browse the repository at this point in the history
Installing with `--no-optional` can reduce a bunyan 1.x install from ~3-4MB to ~450kB.
  • Loading branch information
mistval authored Jun 24, 2020
1 parent 6cb828c commit 89cda5b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,12 @@ all versions of Bunyan logs. Therefore you might want to `npm install -g bunyan`
to get the bunyan CLI on your PATH, then use local bunyan installs for
node.js library usage of bunyan in your apps.

**Tip**: Installing without optional dependencies can dramatically reduce
bunyan's install size. **dtrace-provider** is used for dtrace features,
**mv** is used for RotatingFileStream, and **moment** is used for local time.
If you don't need these features, consider installing with the
`--no-optional` flag.


# Features

Expand Down

0 comments on commit 89cda5b

Please sign in to comment.