From c797106dbe3a55afcee0f4b01f1790c505c9ea2c Mon Sep 17 00:00:00 2001 From: shian15810 Date: Fri, 14 Jun 2019 18:44:06 +0800 Subject: [PATCH] updated readme --- README.md | 25 ++++++++++++++++--------- bin/by-node-env | 3 ++- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4947c3b..bc66597 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # by-node-env -Run package.json scripts by `NODE_ENV`. +Run `package.json` scripts by `NODE_ENV`. -[![travis build](https://img.shields.io/travis/shian15810/by-node-env.svg)](https://travis-ci.org/shian15810/by-node-env) -[![version](https://img.shields.io/npm/v/by-node-env.svg)](http://npm.im/by-node-env) -[![downloads](https://img.shields.io/npm/dm/by-node-env.svg)](http://npm-stat.com/charts.html?package=by-node-env) -[![MIT License](https://img.shields.io/npm/l/by-node-env.svg)](http://opensource.org/licenses/MIT) +[![Travis (.com)](https://img.shields.io/travis/com/shian15810/by-node-env.svg)](https://travis-ci.com/shian15810/by-node-env) +[![npm](https://img.shields.io/npm/v/by-node-env.svg)](https://www.npmjs.com/package/by-node-env) +[![npm](https://img.shields.io/npm/dw/by-node-env.svg)](https://npm-stat.com/charts.html?package=by-node-env) +[![NPM](https://img.shields.io/npm/l/by-node-env.svg)](https://choosealicense.com/licenses/mit/) ## Installation @@ -15,6 +15,12 @@ Install with npm: npm install by-node-env ``` +Install with pnpm: + +```sh +pnpm install by-node-env +``` + Install with Yarn: ```sh @@ -24,14 +30,14 @@ yarn add by-node-env ## Features - [x] Defaults `NODE_ENV` to `development`. -- [x] Customize `process.env` by-node-environment. +- [x] Customize `process.env` for each `NODE_ENV`. - [x] Clearer, concise scripts. - [x] No more Bash-scripting in `package.json`. - [x] Works on Linux, macOS and Windows. -- [x] Compatible with Yarn and npm. +- [x] Compatible with npm, pnpm and Yarn. - [x] Simplify your workflow: - 1. `npm install` or `yarn add`. - 2. `npm start` or `yarn start`. + 1. `npm install` or `pnpm install` or `yarn add`. + 2. `npm start` or `pnpm start` or `yarn start`. ## Example @@ -82,6 +88,7 @@ yarn add by-node-env `by-node-env` is essentially a clone of [`per-env`](https://www.npmjs.com/package/per-env) with some notable fixes: +- pnpm compatibility. - Windows compatibility. - Yarn compatibility. diff --git a/bin/by-node-env b/bin/by-node-env index 31ff205..948b8f1 100755 --- a/bin/by-node-env +++ b/bin/by-node-env @@ -17,7 +17,8 @@ var env = Object.assign( process.env, ); -var command = whichPMRuns().name; +var pm = whichPMRuns(); +var command = pm ? pm.name : 'npm'; if (process.platform === 'win32') { command += '.cmd'; }