Skip to content

Commit cae704f

Browse files
authored
Update README to new standard
1 parent d560695 commit cae704f

File tree

1 file changed

+45
-10
lines changed

1 file changed

+45
-10
lines changed

README.md

+45-10
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,33 @@
11
# webpack-dev-server
22

33
[![npm][npm]][npm-url]
4+
[![node][node]][node-url]
45
[![deps][deps]][deps-url]
5-
[![test][test]][test-url]
6+
[![tests][tests]][tests-url]
7+
[![coverage][cover]][cover-url]
8+
[![chat][chat]][chat-url]
69

7-
Use [webpack](http://webpack.github.io) with a development server that provides live reloading. This should be used for **development only**.
10+
<div align="center">
11+
<a href="https://github.com/webpack/webpack">
12+
<img width="200" height="200"
13+
src="https://webpack.js.org/assets/icon-square-big.svg">
14+
</a>
15+
<h1>webpack Dev Server</h1>
16+
</div>
17+
18+
Use [webpack](https://webpack.js.org) with a development server that provides live reloading. This should be used for **development only**.
819

920
It uses [webpack-dev-middleware](https://github.com/webpack/webpack-dev-middleware) under the hood, which provides fast in-memory access to the webpack assets.
1021

1122
**Note: There are known issues with Node.js v7 and webpack / webpack-dev-server. Please use Node.js v6 for the moment.**
1223

13-
## Installation
24+
<h2 align="center">Install</h2>
1425

1526
```
1627
npm install webpack-dev-server --save-dev
1728
```
1829

19-
## Getting started
30+
<h2 align="center">Usage</h2>
2031

2132
The easiest way to use it is with the CLI. In the directory where your `webpack.config.js` is, run:
2233

@@ -30,24 +41,48 @@ Now, when you change something in your assets, it should live-reload the files.
3041

3142
See [**the documentation**](http://webpack.github.io/docs/webpack-dev-server.html) for more use cases and options.
3243

33-
## Contributing
44+
<h2 align="center">Contributing</h2>
3445

3546
We appreciate all help! Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to help.
3647

37-
## Maintainer
48+
<h2 align="center">Maintainers</h2>
3849

39-
This project is maintained by [**Kees Kluskens**](https://github.com/spacek33z/).
50+
<table>
51+
<tbody>
52+
<tr>
53+
<td align="center">
54+
<img width="150" height="150"
55+
src="https://avatars.githubusercontent.com/SpaceK33z?v=3">
56+
<br />
57+
<a href="https://github.com/">Kees Kluskens</a>
58+
</td>
59+
</tr>
60+
</tbody>
61+
</table>
4062

41-
## Inspiration
63+
<h2 align="center">Inspiration</h2>
4264

4365
This project is heavily inspired by [peerigon/nof5](https://github.com/peerigon/nof5).
4466

67+
<h2 align="center">LICENSE</h2>
68+
69+
#### [MIT](./LICENSE)
70+
4571

4672
[npm]: https://img.shields.io/npm/v/webpack-dev-server.svg
4773
[npm-url]: https://npmjs.com/package/webpack-dev-server
4874

75+
[node]: https://img.shields.io/node/v/webpack-dev-server.svg
76+
[node-url]: https://nodejs.org
77+
4978
[deps]: https://david-dm.org/webpack/webpack-dev-server.svg
5079
[deps-url]: https://david-dm.org/webpack/webpack-dev-server
5180

52-
[test]: http://img.shields.io/travis/webpack/webpack-dev-server.svg
53-
[test-url]: https://travis-ci.org/webpack/webpack-dev-server
81+
[tests]: http://img.shields.io/travis/webpack/webpack-dev-server.svg
82+
[tests-url]: https://travis-ci.org/webpack/webpack-dev-server
83+
84+
[cover]: https://codecov.io/gh/webpack/webpack-dev-server/branch/master/graph/badge.svg
85+
[cover-url]: https://codecov.io/gh/webpack/webpack-dev-server
86+
87+
[chat]: https://badges.gitter.im/webpack/webpack.svg
88+
[chat-url]: https://gitter.im/webpack/webpack

0 commit comments

Comments
 (0)