Readme updates #23
Readme updates #23
Conversation
README.md
Outdated
| "test_watch": "cd www && nodemon test.js" | ||
| }, | ||
| HXML files are a way to specify Haxe compiler arguments; for this loader, configure | ||
| the compiler as for any Haxe-JavaScript project, and add `-lib haxe-loader`: |
There was a problem hiding this comment.
Using -lib haxe-loader isn't actually necessary unless using the Webpack class, and you mention that in the section below. Maybe you can end the sentence "as for any Haxe-JavaScript project."
README.md
Outdated
|
|
||
| To require 3rd party NPM modules, you can use `@:jsRequire` metadata or | ||
| [`js.Lib.require()`](http://api.haxe.org/js/Lib.html#require). | ||
|
|
||
| However, those requires are relative to you HXML file! | ||
| It also cannot be compiled on platforms other than JS. | ||
|
|
||
| It is thus recommended to call instead: | ||
| For assets/styles, it is thus recommended to call instead: |
There was a problem hiding this comment.
I think "it is therefore recommended" sounds better ("thus" seems quite formal to me, but maybe that's because I'm aussie)
README.md
Outdated
|
|
||
| ### Contributing | ||
| ## Contributing | ||
|
|
||
| Don't hesitate to create a pull request. Every contribution is appreciated. |
There was a problem hiding this comment.
Maybe add something for bug reports?
If you encounter a bug, please open a Github issue. As webpack configuration can differ greatly between projects, it is helpful if you can reproduce the bug using our example repository as a starting point.
webpack-tips.md
Outdated
| @@ -0,0 +1,134 @@ | |||
| # Why using Webpack for Haxe developers? | |||
There was a problem hiding this comment.
Maybe
How is Webpack useful for Haxe developers?
There are several reasons to use Webpack when working on a Haxe Javascript project: ....
Rewrote readme to match other Webpack loaders presentation, and moved interesting Webpack tips in a separate file.
Also added cute icons at the top of the page :)
Preview: https://github.com/elsassph/webpack-haxe-loader/tree/readme