diff --git a/README.md b/README.md index 198373bf..3ce33e39 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ [![Build Status](https://travis-ci.org/owais/django-webpack-loader.svg?branch=master)](https://travis-ci.org/owais/django-webpack-loader) [![Coverage Status](https://coveralls.io/repos/owais/django-webpack-loader/badge.svg?branch=master&service=github)](https://coveralls.io/github/owais/django-webpack-loader?branch=master) -
+ Read http://owaislone.org/blog/webpack-plus-reactjs-and-django/ for a detailed step by step guide on setting up webpack with django using this library. -
+ Use webpack to generate your static bundles without django's staticfiles or opaque wrappers. @@ -15,7 +15,6 @@ Use webpack to generate your static bundles without django's staticfiles or opaq Django webpack loader consumes the output generated by [webpack-bundle-tracker](https://github.com/owais/webpack-bundle-tracker) and lets you use the generated bundles in django. -
## Compatibility Test cases cover Django>=1.6 on Python 2.7 and Python>=3.3. 100% code coverage is the target so we can be sure everything works anytime. It should probably work on older version of django as well but the package does not ship any test cases for them. @@ -29,10 +28,10 @@ npm install --save-dev webpack-bundle-tracker pip install django-webpack-loader ``` -
+ ## Configuration -
+ ### Assumptions Assuming `BASE_DIR` in settings refers to the root of your django app. @@ -52,7 +51,6 @@ STATICFILES_DIRS = ( ) ``` -
Assuming your webpack config lives at `./webpack.config.js` and looks like this ```javascript var path = require("path"); @@ -74,7 +72,6 @@ module.exports = { ``` -
### Default Configuration ```python WEBPACK_LOADER = { @@ -88,7 +85,6 @@ WEBPACK_LOADER = { } ``` -
#### CACHE ```python @@ -100,7 +96,6 @@ WEBPACK_LOADER = { ``` When `CACHE` is set to True, webpack-loader will read the stats file only once and cache the result. This means web workers need to be restarted in order to pick up any changes made to the stats files. -
#### BUNDLE_DIR_NAME ```python @@ -119,7 +114,6 @@ If the bundle generates a file called `main-cf4b5fab6e00a404e0c7.js` and your ST