Skip to content

Commit

Permalink
docs(pkg): readme info (#497)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
ematipico authored Jun 29, 2018
1 parent 916f363 commit 46d950f
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions packages/info/README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 46d950f

Please sign in to comment.