diff --git a/js-packages/webpack-config/README.md b/js-packages/webpack-config/README.md index d0a5f917e..9bd3939f1 100755 --- a/js-packages/webpack-config/README.md +++ b/js-packages/webpack-config/README.md @@ -1,10 +1,15 @@ -**Webpack config for Flarum JavaScript compilation.** +**Webpack config factory for Flarum JavaScript compilation.** -This package generates a [Webpack](https://webpack.js.org) config object that will compile JavaScript for use in Flarum. Example usage: +This package generates a [Webpack](https://webpack.js.org) config object that will compile JavaScript for use in Flarum. + +## Usage + +**webpack.config.js** ```js -// webpack.config.js var config = require('flarum-webpack-config'); module.exports = config(); ``` + +To merge in custom Webpack config options, use [webpack-merge](https://www.npmjs.com/package/webpack-merge).