Refactor to compile independently of purescript-webpack-plugin.

[github/fretlink/purs-loader.git] / README.md

diff --git a/README.md b/README.md
index df92e6940ab4971af798cbde078b84656c3fa113..ed25296bea7ea348f8ad83b92d6a053fa6b2ba24 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,16 +2,62 @@
 
 > [PureScript](http://www.purescript.org) loader for [webpack](http://webpack.github.io)
 
+- Supports hot-reloading and rebuilding of single source files
+- Dead code elimination using the `bundle` option
+- Colorized build output using `purescript-psa` and the `psc: "psa"` option
+
 ## Install
 
 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
 ```
 
 ## Example
 
-Refer to the [purescript-webpack-example](https://github.com/ethul/purescript-webpack-example) for an example.
+```javascript
+const webpackConfig = {
+  // ...
+  loaders: [
+    // ...
+    {
+      test: /\.purs$/,
+      loader: 'purs-loader',
+      exclude: /node_modules/,
+      query: {
+        psc: 'psa',
+        src: ['bower_components/purescript-*/src/**/*.purs', 'src/**/*.purs'],
+        ffi: ['bower_components/purescript-*/src/**/*.js', 'src/**/*.js'],
+      }
+    }
+    // ...
+  ]
+  // ...
+}
+```
+
+Default options:
+
+```javascript
+{
+  psc: 'psc',
+  pscArgs: {},
+  pscBundle: 'psc-bundle',
+  pscBundleArgs: {},
+  pscIdeColors: false, // defaults to true if psc === 'psa'
+  bundleOutput: 'output/bundle.js',
+  bundleNamespace: 'PS',
+  bundle: false,
+  warnings: true,
+  output: 'output',
+  src: [
+    path.join('src', '**', '*.purs'),
+    path.join('bower_components', 'purescript-*', 'src', '**', '*.purs')
+  ],
+  ffi: [
+    path.join('src', '**', '*.js'),
+    path.join('bower_components', 'purescript-*', 'src', '**', '*.js')
+  ],
+}
+```