diff --git a/README.md b/README.md index 30cb5e2db52..d0eaa5cd122 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,10 @@ ## WebpackTask ### Description -This task +This task invokes webpack using a consumer-specified `webpack.config.js` on a package. + +### Command Line Options +If the `--initwebpack` flag is passed to the command line, this task will initialize a `webpack.config.js` which bundles `lib/index.js` into `dist/{packagename}.js as a UMD module. ### Config ```typescript @@ -13,4 +16,11 @@ interface IWebpackConfig { configPath: string; } ``` -` +* **configPath** used to specify the local package relative path to a `webpack.config.js` + +Usage: +```typescript +build.webpack.setConfig({ + configPath: "./webpack.config.js" +}) +```