Version 2.2.0

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

diff --git a/README.md b/README.md
index ed25296bea7ea348f8ad83b92d6a053fa6b2ba24..292ab85b53b0048b71102970f42b1890baf4a73a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,7 +11,11 @@
 Install with [npm](https://npmjs.org/package/purs-loader).
 
 ```
+// For PureScript 0.9 and newer
 npm install purs-loader --save-dev
+
+// Fore PureScript 0.8
+npm install purs-loader@purescript-0.8 --save-dev
 ```
 
 ## Example
@@ -27,8 +31,7 @@ const webpackConfig = {
       exclude: /node_modules/,
       query: {
         psc: 'psa',
-        src: ['bower_components/purescript-*/src/**/*.purs', 'src/**/*.purs'],
-        ffi: ['bower_components/purescript-*/src/**/*.js', 'src/**/*.js'],
+        src: ['bower_components/purescript-*/src/**/*.purs', 'src/**/*.purs']
       }
     }
     // ...
@@ -37,6 +40,10 @@ const webpackConfig = {
 }
 ```
 
+Refer to the [purescript-webpack-example](https://github.com/ethul/purescript-webpack-example) for a more detailed example.
+
+### Options
+
 Default options:
 
 ```javascript
@@ -45,6 +52,9 @@ Default options:
   pscArgs: {},
   pscBundle: 'psc-bundle',
   pscBundleArgs: {},
+  pscIde: false, // instant rebuilds using psc-ide-server (experimental)
+  pscIdeArgs: {}, // for example, to use different psc-ide-server port: {port: 4088}
+  pscIdeServerArgs: {}, // for example, to change the port { port: 4088 }
   pscIdeColors: false, // defaults to true if psc === 'psa'
   bundleOutput: 'output/bundle.js',
   bundleNamespace: 'PS',
@@ -54,10 +64,26 @@ Default options:
   src: [
     path.join('src', '**', '*.purs'),
     path.join('bower_components', 'purescript-*', 'src', '**', '*.purs')
-  ],
-  ffi: [
-    path.join('src', '**', '*.js'),
-    path.join('bower_components', 'purescript-*', 'src', '**', '*.js')
-  ],
+  ]
 }
 ```
+
+### Instant rebuilds (experimental)
+
+Experimental support for instant rebuilds using `psc-ide-server` can be enabled
+via the `pscIde: true` option.
+You can use an already running `psc-ide-server` instance by specifying the port in `pscIdeArgs`,
+if there is no server running this loader will start one for you.
+
+
+#### Slower webpack startup after using purs-loader ?
+
+By default, the psc-ide-server will be passed the globs from query.src, this is
+helpful for other tools using psc-ide-server (for example IDE plugins), however
+it might result in a slower initial webpack startup time (rebuilds are not
+affected). To override the default behaviour, add:
+`pscIdeServerArgs: { "_": ['your/*globs/here'] }` to the loader config
+
+
+
+