Skip to content
This repository was archived by the owner on Aug 20, 2018. It is now read-only.

docs(README): refactor for webpack v2 #39

Merged
merged 2 commits into from
Jan 11, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 88 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,95 @@
# json 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="160" height="180"
src="https://worldvectorlogo.com/logos/json.svg">
<a href="https://github.com/webpack/webpack">
<img width="200" height="200"
src="https://webpack.js.org/assets/icon-square-big.svg">
</a>
<h1>JSON Loader</h1>
</div>

`npm install --save json-loader`
**Note: Since webpack v2, JSON files will work by default. You might still want to use this if you use a custom file extension.**

## Usage
<h2 align="center">Install</h2>

``` javascript
var json = require("json-loader!./file.json");
// => returns file.json content as json parsed object
```bash
npm install --save-dev json-loader
```

## License
<h2 align="center">Usage</h2>

MIT (http://www.opensource.org/licenses/mit-license.php)

### Configuration (recommended)

**webpack.config.js**
```js
module.exports = {
module: {
rules: [
{
test: /\.json$/,
use: 'json-loader'
}
]
}
}
```

```js
import json from 'file.json';
```

### CLI

```bash
webpack --module-bind 'json=json-loader'
```

```js
import json from 'file.json';
```

### Inline

```js
import json from 'json-loader!file.json';
```

<h2 align="center">Maintainer</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/json-loader.svg
[npm-url]: https://npmjs.com/package/json-loader

[node]: https://img.shields.io/node/v/json-loader.svg
[node-url]: https://nodejs.org

[deps]: https://david-dm.org/webpack/json-loader.svg
[deps-url]: https://david-dm.org/webpack/json-loader

[tests]: http://img.shields.io/travis/webpack/json-loader.svg
[tests-url]: https://travis-ci.org/webpack/json-loader

[cover]: https://coveralls.io/repos/github/webpack/json-loader/badge.svg
[cover-url]: https://coveralls.io/github/webpack/json-loader

[chat]: https://badges.gitter.im/webpack/webpack.svg
[chat-url]: https://gitter.im/webpack/webpack