Update README formatting

This commit is contained in:
Toby Zerner 2018-06-16 14:34:12 +09:30
parent fca781f98a
commit 7975757829

View File

@ -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).