diff --git a/README.md b/README.md index ff6d7e2..3867cd4 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,24 @@ -# react-proxy-loader - -Wraps a react component in a proxy component to enable Code Splitting (loads a react component and its dependencies on demand). - -## installation - -`npm install react-proxy-loader` +[![npm][npm]][npm-url] +[![deps][deps]][deps-url] +[![chat][chat]][chat-url] + +
+ + + + +

React Proxy Loader

+

Wraps a react component in a proxy component to enable Code Splitting (loads a react component and its dependencies on demand).

+

+ +

Install

+ +```bash +npm install react-proxy-loader` +``` -## Usage +

Usage

[Documentation: Using loaders](http://webpack.github.io/docs/using-loaders.html) @@ -28,7 +40,7 @@ var ComponentProxy = React.createClass({ The proxy is a react component. All properties are transferred to the wrapped component. -### Configuration +

Configuration

Instead of (or in addition to) inlining the loader call you can also specify the proxied components in your configuration: @@ -58,6 +70,45 @@ You can give the chunk a name with the `name` query parameter: var Component = require("react-proxy-loader?name=chunkName!./Component"); ``` -# License - -MIT (http://www.opensource.org/licenses/mit-license.php) +

Maintainers

+ + + + + + + + + + +
+ +
+ Juho Vepsäläinen +
+ +
+ Joshua Wiens +
+ +
+ Kees Kluskens +
+ +
+ Sean Larkin +
+ + +[npm]: https://img.shields.io/npm/v/react-proxy-loader.svg +[npm-url]: https://npmjs.com/package/react-proxy-loader + +[deps]: https://david-dm.org/webpack-contrib/react-proxy-loader.svg +[deps-url]: https://david-dm.org/webpack-contrib/react-proxy-loader + +[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg +[chat-url]: https://gitter.im/webpack/webpack