From 46d950f1f424b929bcc4a52092cbc46c7fa029aa Mon Sep 17 00:00:00 2001 From: Emanuele Date: Fri, 29 Jun 2018 08:55:09 +0100 Subject: [PATCH] docs(pkg): readme info (#497) * docs(pkg): readme info Created read me file for info sub package * docs(readme): added usage example * Updated usage * Fixed correct package * docs(info): small typo --- packages/info/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 packages/info/README.md diff --git a/packages/info/README.md b/packages/info/README.md new file mode 100644 index 00000000000..1948f1ba01d --- /dev/null +++ b/packages/info/README.md @@ -0,0 +1,24 @@ +# webpack-cli info + +## Description + +It returns a set of information related to the local enviroment. + +## Installation + +```bash +npm i -D @webpack-cli/info +``` + +## Usage + +### Node +```js +const envinfo = require("@webpack-cli/info"); +envinfo(); +``` + +### CLI (via `webpack-cli`) +```bash +npx webpack-cli info +```