Add information about potentially slowing down webpack startup

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

diff --git a/README.md b/README.md
index 9d6166b075cbf7a4ef537ecd0da3afff4a6f0458..292ab85b53b0048b71102970f42b1890baf4a73a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -54,6 +54,7 @@ Default options:
   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',
@@ -71,4 +72,18 @@ Default options:
 
 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`.
+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
+
+
+
+