Skip to content

Commit 333e619

Browse files
joshwiensSpaceK33z
authored andcommitted
chore(readme): Update to webpack standard format
1 parent 66af94d commit 333e619

File tree

1 file changed

+50
-12
lines changed

1 file changed

+50
-12
lines changed

README.md

Lines changed: 50 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
# webpack-dev-middleware
2-
31
[![npm][npm]][npm-url]
2+
[![node][node]][node-url]
43
[![deps][deps]][deps-url]
5-
[![test][test]][test-url]
4+
[![tests][tests]][tests-url]
65
[![coverage][cover]][cover-url]
6+
[![chat][chat]][chat-url]
77

8-
**THIS MIDDLEWARE SHOULD ONLY BE USED FOR DEVELOPMENT!**
9-
10-
**DO NOT USE IT IN PRODUCTION!**
11-
12-
## What is it?
8+
<div align="center">
9+
<a href="https://github.com/webpack/webpack">
10+
<img width="200" height="200"
11+
src="https://webpack.js.org/assets/icon-square-big.svg">
12+
</a>
13+
<h1>Webpack Dev Middleware</h1>
14+
</div>
1315

1416
It's a simple wrapper middleware for webpack. It serves the files emitted from webpack over a connect server.
1517

@@ -19,13 +21,13 @@ It has a few advantages over bundling it as files:
1921
* If files changed in watch mode, the middleware no longer serves the old bundle, but delays requests until the compiling has finished. You don't have to wait before refreshing the page after a file modification.
2022
* I may add some specific optimization in future releases.
2123

22-
## Installation
24+
<h2 align="center">Install</h2>
2325

2426
```
2527
npm install webpack-dev-middleware --save-dev
2628
```
2729

28-
## Usage
30+
<h2 align="center">Usage</h2>
2931

3032
``` javascript
3133
var webpackMiddleware = require("webpack-dev-middleware");
@@ -168,14 +170,50 @@ app.use((req, res) => {
168170
})
169171
```
170172
173+
<h2 align="center">Contributing</h2>
174+
175+
Don't hesitate to create a pull request. Every contribution is appreciated. In development you can start the tests by calling `npm test`.
176+
177+
<h2 align="center">Maintainers</h2>
178+
179+
<table>
180+
<tbody>
181+
<tr>
182+
<td align="center">
183+
<img width="150 height="150"
184+
src="https://avatars.githubusercontent.com/sokra?v=3">
185+
<br />
186+
<a href="https://github.com/">Tobias Koppers</a>
187+
</td>
188+
<td align="center">
189+
<img width="150 height="150"
190+
src="https://avatars.githubusercontent.com/SpaceK33z?v=3">
191+
<br />
192+
<a href="https://github.com/">Kees Kluskens</a>
193+
</td>
194+
<tr>
195+
<tbody>
196+
</table>
197+
198+
199+
<h2 align="center">LICENSE</h2>
200+
201+
#### [MIT](./LICENSE)
202+
171203
[npm]: https://img.shields.io/npm/v/webpack-dev-middleware.svg
172204
[npm-url]: https://npmjs.com/package/webpack-dev-middleware
173205
206+
[node]: https://img.shields.io/node/v/webpack-dev-middleware.svg
207+
[node-url]: https://nodejs.org
208+
174209
[deps]: https://david-dm.org/webpack/webpack-dev-middleware.svg
175210
[deps-url]: https://david-dm.org/webpack/webpack-dev-middleware
176211
177-
[test]: http://img.shields.io/travis/webpack/webpack-dev-middleware.svg
178-
[test-url]: https://travis-ci.org/webpack/webpack-dev-middleware
212+
[tests]: http://img.shields.io/travis/webpack/webpack-dev-middleware.svg
213+
[tests-url]: https://travis-ci.org/webpack/webpack-dev-middleware
179214
180215
[cover]: https://codecov.io/gh/webpack/webpack-dev-middleware/branch/master/graph/badge.svg
181216
[cover-url]: https://codecov.io/gh/webpack/webpack-dev-middleware
217+
218+
[chat]: https://badges.gitter.im/webpack/webpack.svg
219+
[chat-url]: https://gitter.im/webpack/webpack

0 commit comments

Comments
 (0)