diff --git a/README.md b/README.md index 8dc37a9f6..67e0c07c8 100644 --- a/README.md +++ b/README.md @@ -13,18 +13,19 @@ Examples of things that would be a problem: - Weirdo `exports` configuration - Wonky lifecycle scripts -`midnight-smoker` is intended to run in CI or in a pre-publish lifecycle script. +`midnight-smoker` is intended to run in a pre-publish lifecycle script and/or in your CI pipeline. ## Example Usage ```bash -npx midnight-smoker test:smoke # runs npm script "test:smoke" -💨 midnight-smoker v1.0.0 -✔ Found npm at /wherever/npm/lives/bin/npm -✔ Packed 1 package -✔ Installed 1 package +npx midnight-smoker test:smoke # runs script "test:smoke" from `package.json` + +💨 midnight-smoker v5.1.0 +✔ Packed 1 unique package using npm@latest… +✔ Installed 1 unique package from tarball +✔ Successfully ran 4 checks ✔ Successfully ran 1 script ✔ Lovey-dovey! 💖 ``` @@ -35,19 +36,19 @@ npx midnight-smoker test:smoke # runs npm script "test:smoke" ## What It Does -Three (3) things: - -1. It runs `npm pack` on the package(s) -2. Installs the resulting tarball(s) to a temp dir (or dir of your choosing) using [`--install-strategy=shallow`/`--global-style`](https://docs.npmjs.com/cli/v9/using-npm/config#install-strategy) to avoid hoisting/deduping. This will install _only_ "production" dependencies. -3. For each package, executes `npm run