Merge pull request #12 from michael-ciniawsky/readme

docs(README): refactor for webpack v2

Author: TheLarkInn

README.md

@@ -1,18 +1,98 @@
-# raw loader for webpack
+[![npm][npm]][npm-url]
+[![node][node]][node-url]
+[![deps][deps]][deps-url]
+[![tests][tests]][tests-url]
+[![coverage][cover]][cover-url]
+[![chat][chat]][chat-url]
 
-## Installation
+<div align="center">
+  <img width="200" height="200"
+    src="https://cdn3.iconfinder.com/data/icons/lexter-flat-colorfull-file-formats/56/raw-256.png">
+  <a href="https://github.com/webpack/webpack">
+    <img width="200" height="200"
+      src="https://webpack.js.org/assets/icon-square-big.svg">
+  </a>
+  <h1>Raw Loader</h1>
+  <h3>A loader for webpack that lets you import files as a string.</h3>
+</div>
 
-`npm install raw-loader`
+<h2 align="center">Install</h2>
 
-## Usage
+```bash
+npm install --save-dev raw-loader
+```
+
+<h2 align="center">Usage</h2>
+
+Use the loader either via your webpack config, CLI or inline.
+
+### Via webpack config (recommended)
+
+**webpack.config.js**
+```js
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.txt$/,
+        use: 'raw-loader'
+      }
+    ]
+  }
+}
+```
 
-``` javascript
-var fileContent = require("raw-loader!./file.txt");
-// => returns file.txt content as string
+**In your application**
+```js
+import txt from 'file.txt';
 ```
 
-[Documentation: Using loaders](http://webpack.github.io/docs/using-loaders.html)
+### CLI
+
+```bash
+webpack --module-bind 'txt=raw-loader'
+```
+
+**In your application**
+```js
+import txt from 'file.txt';
+```
+
+### Inline
+
+**In your application**
+```js
+import txt from 'raw-loader!./file.txt';
+```
+
+<h2 align="center">Maintainers</h2>
+
+<table>
+  <tbody>
+    <tr>
+      <td align="center">
+        <img width="150 height="150" src="https://github.com/sokra.png?s=150">
+        <br>
+        <a href="https://github.com/sokra">Tobias Koppers</a>
+      </td>
+    <tr>
+  <tbody>
+</table>
+
+[npm]: https://img.shields.io/npm/v/raw-loader.svg
+[npm-url]: https://npmjs.com/package/raw-loader
+
+[node]: https://img.shields.io/node/v/raw-loader.svg
+[node-url]: https://nodejs.org
+
+[deps]: https://david-dm.org/webpack/raw-loader.svg
+[deps-url]: https://david-dm.org/webpack/raw-loader
+
+[tests]: http://img.shields.io/travis/webpack/raw-loader.svg
+[tests-url]: https://travis-ci.org/webpack/raw-loader
 
-## License
+[cover]: https://coveralls.io/repos/github/webpack/raw-loader/badge.svg
+[cover-url]: https://coveralls.io/github/webpack/raw-loader
 
-MIT (http://www.opensource.org/licenses/mit-license.php)
+[chat]: https://badges.gitter.im/webpack/webpack.svg
+[chat-url]: https://gitter.im/webpack/webpack