]> git.immae.eu Git - github/fretlink/purs-loader.git/blobdiff - README.md
Bumping version number to 0.6.0-beta.6
[github/fretlink/purs-loader.git] / README.md
index d243381aa0b11dbe5131d78433920299f242bb76..df92e6940ab4971af798cbde078b84656c3fa113 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,50 +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
-
-###### `noPrelude` (Boolean)
-
-Toggles `--no-prelude` that omits the Prelude.
-
-###### `noTco` (Boolean)
-
-Toggles `--no-tco` that disables tail-call optimizations.
-
-###### `noMagicDo` (Boolean)
-
-Toggles `--no-magic-do` that disables optimizations overloading the do keyword generating efficient code for the `Eff` monad.
-
-###### `noOpts` (Boolean)
-
-Toggles `--no-opts` that skips the optimization phase.
-
-###### `verboseErrors` (Boolean)
-
-Toggles `--verbose-errors` that displays verbose error messages.
-
-###### `comments` (Boolean)
-
-Toggles `--comments` that includes comments in generated code.
-
-###### `output` (String)
-
-Sets `--output=<string>` the specifies the output directory, `output` by default.
-
-###### `noPrefix` (Boolean)
-
-Toggles `--no-prefix` that does not include the comment header.
-
-###### `src` (String Array)
-
-Specifies PureScript source paths to be globbed for `.purs` files. By default, `bower_components` is search. Additional paths may be specified using this option. This option is specified as `src[]=path`.
-
 ## 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.