search

Macil / browserify-hmr

Hot Module Replacement plugin for Browserify
MIT License
373 stars 26 forks source link

Document module.hot.accept #5

Closed apaleslimghost closed 8 years ago

apaleslimghost commented 8 years ago

If you're not coming from Webpack, there's no way of knowing this is needed.

Macil commented 8 years ago

The readme has a link to the hot module replacement API documentation.

I agree the readme needs a little more information on getting started with it. I expect that most people using hot module replacement are (or should be) using other tools to automatically apply or wrap around it, like react-transform-hmr and ud, rather than using calls to module.hot.* themselves, so I don't want the readme to introduce people to hot module replacement by explaining the module.hot.* functions first. Because Webpack already has decent documentation on those functions, I'd rather link to them (also to help emphasize the fact that this project is compatible with code using those functions with Webpack).

Macil commented 8 years ago

I've added a "Hot Module Replacement Usage" section to the readme which I hope functions as a better introduction to the plugin.

apaleslimghost commented 8 years ago

That's great, thanks.