initial psc-package support (#82)

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

diff --git a/README.md b/README.md
index 292ab85b53b0048b71102970f42b1890baf4a73a..add775669bcfc7307938e25cc3813f807f55f95c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ Refer to the [purescript-webpack-example](https://github.com/ethul/purescript-we
 Default options:
 
 ```javascript
-{
+const loaderConfig = {
   psc: 'psc',
   pscArgs: {},
   pscBundle: 'psc-bundle',
@@ -56,6 +56,7 @@ Default options:
   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'
+  pscPackage: false,
   bundleOutput: 'output/bundle.js',
   bundleNamespace: 'PS',
   bundle: false,
@@ -63,7 +64,11 @@ Default options:
   output: 'output',
   src: [
     path.join('src', '**', '*.purs'),
+    // if pscPackage = false
     path.join('bower_components', 'purescript-*', 'src', '**', '*.purs')
+    /*
+     * OR source paths reported by `psc-package sources`, if pscPackage = true
+     */
   ]
 }
 ```
@@ -84,6 +89,7 @@ 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
 
+### `psc-package` support (experimental)
 
-
-
+Set `pscPackage` query parameter to `true` to enable `psc-package` support. The `psc-package`-supplied source paths 
+will be appended to `src` parameter.