Skip to content

Commit de8f05e

Browse files
committed
Document brfs requirement for usage with webpack
Relates to Flipboard#102 Flipboard#110 Flipboard#114
1 parent 0940a73 commit de8f05e

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,26 @@ This will start a live reloading server on port 8080. To override the default se
200200

201201
**A note on NODE_ENV and React**: running the examples with `NODE_ENV=production` will noticeably improve scrolling performance. This is because React skips propType validation in production mode.
202202

203+
204+
## Using with webpack
205+
206+
The [brfs](https://github.com/substack/brfs) transform is required in order to use the project with webpack.
207+
208+
```bash
209+
npm install -g brfs
210+
npm install --save-dev transform-loader brfs
211+
```
212+
213+
Then add the [brfs](https://github.com/substack/brfs) transform to your webpack config
214+
215+
```javascript
216+
module: {
217+
postLoaders: [
218+
{ loader: "transform?brfs" }
219+
]
220+
}
221+
```
222+
203223
## Contributing
204224

205225
We welcome pull requests for bug fixes, new features, and improvements to React Canvas. Contributors to the main repository must accept Flipboard's Apache-style [Individual Contributor License Agreement (CLA)](https://docs.google.com/forms/d/1gh9y6_i8xFn6pA15PqFeye19VqasuI9-bGp_e0owy74/viewform) before any changes can be merged.
206-

0 commit comments

Comments
 (0)