Skip to content

Commit 737f5bc

Browse files
docs: fix readme (#413)
1 parent 9138b13 commit 737f5bc

File tree

1 file changed

+35
-16
lines changed

1 file changed

+35
-16
lines changed

README.md

+35-16
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
[![npm][npm]][npm-url]
2-
[![node][node]][node-url]
3-
[![deps][deps]][deps-url]
4-
[![test][test]][test-url]
5-
[![coverage][cover]][cover-url]
6-
[![chat][chat]][chat-url]
7-
81
<div align="center">
92
<a href='https://github.com/karma-runner/karma'>
103
<img width="180" height="180"
@@ -14,17 +7,29 @@
147
<img width="200" height="200"
158
src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg">
169
</a>
17-
<h1>Karma Webpack</h1>
18-
<p>Use webpack to preprocess files in karma<p>
1910
</div>
2011

21-
<h2 align="center">Install</h2>
12+
[![npm][npm]][npm-url]
13+
[![node][node]][node-url]
14+
[![deps][deps]][deps-url]
15+
[![tests][tests]][tests-url]
16+
[![coverage][cover]][cover-url]
17+
[![chat][chat]][chat-url]
18+
[![size][size]][size-url]
19+
20+
# karma-webpack
2221

23-
```bash
24-
npm i -D karma-webpack
22+
Use webpack to preprocess files in karma.
23+
24+
## Getting Started
25+
26+
To begin, you'll need to install `karma-webpack`:
27+
28+
```console
29+
npm i --save-dev karma-webpack
2530
```
2631

27-
<h2 align="center">Usage</h2>
32+
Then add config:
2833

2934
**karma.conf.js**
3035

@@ -123,7 +128,7 @@ webpack: {
123128
}
124129
```
125130

126-
<h2 align="center">Options</h2>
131+
## Options
127132

128133
This is the full list of options you can specify in your `karma.conf.js`
129134

@@ -158,6 +163,16 @@ the files until the code has finished recompiling.
158163

159164
> **⚠️ The `beforeMiddleware` option is only supported in `karma >= v1.0.0`**
160165
166+
## Contributing
167+
168+
Please take a moment to read our contributing guidelines if you haven't yet done so.
169+
170+
[CONTRIBUTING](./.github/CONTRIBUTING.md)
171+
172+
## License
173+
174+
[MIT](./LICENSE)
175+
161176
[npm]: https://img.shields.io/npm/v/karma-webpack.svg
162177
[npm-url]: https://npmjs.com/package/karma-webpack
163178
[node]: https://img.shields.io/node/v/karma-webpack.svg
@@ -166,7 +181,11 @@ the files until the code has finished recompiling.
166181
[deps-url]: https://david-dm.org/webpack-contrib/karma-webpack
167182
[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
168183
[chat-url]: https://gitter.im/webpack/webpack
169-
[test]: http://img.shields.io/travis/webpack-contrib/karma-webpack.svg
170-
[test-url]: https://travis-ci.org/webpack-contrib/karma-webpack
184+
[tests]: https://dev.azure.com/webpack-contrib/karma-webpack/_apis/build/status/webpack-contrib.karma-webpack?branchName=master
185+
[tests-url]: https://dev.azure.com/webpack-contrib/karma-webpack/_build/latest?definitionId=2&branchName=master
171186
[cover]: https://codecov.io/gh/webpack-contrib/karma-webpack/branch/master/graph/badge.svg
172187
[cover-url]: https://codecov.io/gh/webpack-contrib/karma-webpack
188+
[chat]: https://badges.gitter.im/webpack/webpack.svg
189+
[chat-url]: https://gitter.im/webpack/webpack
190+
[size]: https://packagephobia.now.sh/badge?p=css-loader
191+
[size-url]: https://packagephobia.now.sh/result?p=css-loader

0 commit comments

Comments
 (0)