X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=150c2c06d5fdc88840a50896a39fbb0dc45c2f9a;hb=cbb7579562d203e99a1f751d8f518e680d5b81eb;hp=292ab85b53b0048b71102970f42b1890baf4a73a;hpb=4343e0eb79b0324d7f4c4eed081780faeaa836a0;p=github%2Ffretlink%2Fpurs-loader.git

diff --git a/README.md b/README.md
index 292ab85..150c2c0 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ 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
+// For PureScript 0.8
 npm install purs-loader@purescript-0.8 --save-dev
 ```
 
@@ -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,19 +56,24 @@ 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,
   warnings: true,
+  watch: false, // indicates if webpack is in watch mode
   output: 'output',
   src: [
     path.join('src', '**', '*.purs'),
+    // if pscPackage = false
     path.join('bower_components', 'purescript-*', 'src', '**', '*.purs')
+    // if pscPackage = true
+    // source paths reported by `psc-package sources`
   ]
 }
 ```
 
-### Instant rebuilds (experimental)
+### `psc-ide` support (experimental)
 
 Experimental support for instant rebuilds using `psc-ide-server` can be enabled
 via the `pscIde: true` option.
@@ -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.