Skip to content
This repository was archived by the owner on Jul 27, 2021. It is now read-only.

Commit 8470e14

Browse files
author
Rogelio Guzman
authored
Add getting started to README
1 parent 58693b3 commit 8470e14

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,30 @@ Developer Experience.
1010
It is easy to add types of errors so if you would like to see more
1111
errors get handled, please open a [PR](https://help.github.com/articles/creating-a-pull-request/)!
1212

13+
## Getting started
14+
15+
### Installation
16+
17+
```bash
18+
npm install friendly-errors-webpack-plugin --save-dev
19+
```
20+
21+
### Basic usage
22+
23+
Simply add `FriendlyErrorsWebpackPlugin` to the plugin section in your Webpack config.
24+
25+
```javascript
26+
var FriendlyErrorsWebpackPlugin = require('friendly-errors-webpack-plugin');
27+
28+
var webpackConfig = {
29+
// ...
30+
plugins: [
31+
new FriendlyErrorsWebpackPlugin(),
32+
],
33+
// ...
34+
}
35+
```
36+
1337
## Demo
1438

1539
### Build success

0 commit comments

Comments
 (0)