X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=df92e6940ab4971af798cbde078b84656c3fa113;hb=e533e59f321e001c6a6dd1945af546af9b0a4e67;hp=ee964484df6561d94f07e8eaa07d1292843b9838;hpb=464355c740940df632eef951c6c84eb2767b5ab3;p=github%2Ffretlink%2Fpurs-loader.git diff --git a/README.md b/README.md index ee96448..df92e69 100644 --- a/README.md +++ b/README.md @@ -4,27 +4,14 @@ ## Install -Install with [npm](https://npmjs.org/package/purs-loader) +Install with [npm](https://npmjs.org/package/purs-loader). + +This loader works in conjunction with the [PureScript webpack plugin](https://npmjs.org/package/purescript-webpack-plugin). Ensure the plugin is installed and configured accordingly. ``` npm install purs-loader --save-dev ``` -## Options - - - **no-prelude**: Boolean value that toggles `--no-prelude` - - Do not include the Prelude in the generated Javascript. - - **no-opts**: Boolean value that toggles `--no-opts` - - Disable all optimizations. - - **no-magic-do**: Boolean value that toggles `--no-magic-do` - - Turn off optimizations which inline calls to >>= for the Eff monad. - - **no-tco**: Boolean value that toggles `--no-tco` - - Turn off tail-call elimination. - - **verbose-errors**: Boolean value that toggles `--verbose-errors` - - Generate verbose error messages. - - **output**: String value that sets `--output=` - - Write the generated Javascript to the specified file. - ## Example -See the [example](https://github.com/ethul/purs-loader/tree/master/example) directory for a complete example. +Refer to the [purescript-webpack-example](https://github.com/ethul/purescript-webpack-example) for an example.