UNPKG

1.96 kBMarkdownView Raw
1<div align="center">
2 <a href="https://github.com/webpack/webpack">
3 <img width="200" height="200" src="https://webpack.js.org/assets/icon-square-big.svg">
4 </a>
5</div>
6
7[![npm][npm]][npm-url]
8[![node][node]][node-url]
9[![deps][deps]][deps-url]
10[![tests][tests]][tests-url]
11[![chat][chat]][chat-url]
12[![size][size]][size-url]
13
14# webpack-defaults
15
16Project configuration and boilerplate defaults for webpack projects
17
18## Requirements
19
20This module requires a minimum of Node v6.9.0 and Webpack v4.0.0.
21
22## Getting Started
23
24To begin, you'll need to install `webpack-defaults`:
25
26```console
27$ npm install @webpack-contrib/defaults --save-dev
28```
29
30After install a `defaults` NPM script will be written to the local
31`package.json`. To sync a project with webpack-defaults, simply run:
32
33```
34npm run defaults
35```
36
37## Contributing
38
39Please take a moment to read our contributing guidelines if you haven't yet done so.
40
41#### [CONTRIBUTING](./.github/CONTRIBUTING)
42
43## License
44
45#### [MIT](./LICENSE)
46
47[npm]: https://img.shields.io/npm/v/@webpack-contrib/defaults.svg
48[npm-url]: https://npmjs.com/package/@webpack-contrib/defaults
49
50[node]: https://img.shields.io/node/v/@webpack-contrib/defaults.svg
51[node-url]: https://nodejs.org
52
53[deps]: https://david-dm.org/webpack-contrib/webpack-defaults.svg
54[deps-url]: https://david-dm.org/webpack-contrib/webpack-defaults
55
56[tests]: https://img.shields.io/circleci/project/github/webpack-contrib/webpack-defaults.svg
57[tests-url]: https://circleci.com/gh/webpack-contrib/webpack-defaults
58
59[cover]: https://codecov.io/gh/webpack-contrib/webpack-defaults/branch/master/graph/badge.svg
60[cover-url]: https://codecov.io/gh/webpack-contrib/webpack-defaults
61
62[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
63[chat-url]: https://gitter.im/webpack/webpack
64
65[size]: https://packagephobia.now.sh/badge?p=@webpack-contrib/defaults
66[size-url]: https://packagephobia.now.sh/result?p=@webpack-contrib/defaults