Skip to content

Commit

Permalink
Merge pull request #107 from chrisblossom/master
Browse files Browse the repository at this point in the history
update readme to include special instructions for v1 users
  • Loading branch information
chrisblossom committed Mar 5, 2019
2 parents 4962f3a + 17791bc commit 4f72f5b
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Expand Up @@ -25,6 +25,8 @@ A webpack plugin to remove/clean your build folder(s).

By default, this plugin will remove all files inside webpack's `output.path` directory, as well as all unused webpack assets after every successful rebuild.

> Coming from `v1`? Please read about [additional v2 information](https://github.com/johnagan/clean-webpack-plugin/issues/106).
## Installation

`npm install --save-dev clean-webpack-plugin`
Expand All @@ -36,7 +38,17 @@ const CleanWebpackPlugin = require('clean-webpack-plugin');

const webpackConfig = {
plugins: [
// See Options and Defaults
/**
* All files inside webpack's output.path directory will be removed once, but the
* directory itself will not be. If using webpack 4+'s default configuration,
* everything under <PROJECT_DIR>/dist/ will be removed.
* Use cleanOnceBeforeBuildPatterns to override this behavior.
*
* During rebuilds, all webpack assets that are not used anymore
* will be removed automatically.
*
* See `Options and Defaults` for for information
*/
new CleanWebpackPlugin(),
],
};
Expand Down

0 comments on commit 4f72f5b

Please sign in to comment.