From 737f5bcaa1bded679e882f236c74c2c7762401b7 Mon Sep 17 00:00:00 2001
From: Evilebot Tnawi <evilebottnawi@users.noreply.github.com>
Date: Fri, 7 Jun 2019 19:18:23 +0300
Subject: [PATCH] docs: fix readme (#413)

---
 README.md | 51 +++++++++++++++++++++++++++++++++++----------------
 1 file changed, 35 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 6a40659..d27ee78 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,3 @@
-[![npm][npm]][npm-url]
-[![node][node]][node-url]
-[![deps][deps]][deps-url]
-[![test][test]][test-url]
-[![coverage][cover]][cover-url]
-[![chat][chat]][chat-url]
-
 <div align="center">
   <a href='https://github.com/karma-runner/karma'>
     <img width="180" height="180"
@@ -14,17 +7,29 @@
     <img width="200" height="200"
       src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg">
   </a>
-  <h1>Karma Webpack</h1>
-  <p>Use webpack to preprocess files in karma<p>
 </div>
 
-<h2 align="center">Install</h2>
+[![npm][npm]][npm-url]
+[![node][node]][node-url]
+[![deps][deps]][deps-url]
+[![tests][tests]][tests-url]
+[![coverage][cover]][cover-url]
+[![chat][chat]][chat-url]
+[![size][size]][size-url]
+
+# karma-webpack
 
-```bash
-npm i -D karma-webpack
+Use webpack to preprocess files in karma.
+
+## Getting Started
+
+To begin, you'll need to install `karma-webpack`:
+
+```console
+npm i --save-dev karma-webpack
 ```
 
-<h2 align="center">Usage</h2>
+Then add config:
 
 **karma.conf.js**
 
@@ -123,7 +128,7 @@ webpack: {
 }
 ```
 
-<h2 align="center">Options</h2>
+## Options
 
 This is the full list of options you can specify in your `karma.conf.js`
 
@@ -158,6 +163,16 @@ the files until the code has finished recompiling.
 
 > **⚠️ The `beforeMiddleware` option is only supported in `karma >= v1.0.0`**
 
+## Contributing
+
+Please take a moment to read our contributing guidelines if you haven't yet done so.
+
+[CONTRIBUTING](./.github/CONTRIBUTING.md)
+
+## License
+
+[MIT](./LICENSE)
+
 [npm]: https://img.shields.io/npm/v/karma-webpack.svg
 [npm-url]: https://npmjs.com/package/karma-webpack
 [node]: https://img.shields.io/node/v/karma-webpack.svg
@@ -166,7 +181,11 @@ the files until the code has finished recompiling.
 [deps-url]: https://david-dm.org/webpack-contrib/karma-webpack
 [chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
 [chat-url]: https://gitter.im/webpack/webpack
-[test]: http://img.shields.io/travis/webpack-contrib/karma-webpack.svg
-[test-url]: https://travis-ci.org/webpack-contrib/karma-webpack
+[tests]: https://dev.azure.com/webpack-contrib/karma-webpack/_apis/build/status/webpack-contrib.karma-webpack?branchName=master
+[tests-url]: https://dev.azure.com/webpack-contrib/karma-webpack/_build/latest?definitionId=2&branchName=master
 [cover]: https://codecov.io/gh/webpack-contrib/karma-webpack/branch/master/graph/badge.svg
 [cover-url]: https://codecov.io/gh/webpack-contrib/karma-webpack
+[chat]: https://badges.gitter.im/webpack/webpack.svg
+[chat-url]: https://gitter.im/webpack/webpack
+[size]: https://packagephobia.now.sh/badge?p=css-loader
+[size-url]: https://packagephobia.now.sh/result?p=css-loader