Merge pull request #6 from ethul/topic/bower-components

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

diff --git a/README.md b/README.md
index 17fe7357f5c80152e9f53e31bce92c012fd78dbf..dcbedf285102349f9d2a002448af136529f1625d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # purs-loader
 
-> [PureScript](http://www.purescript.org) loader for [webpack](https://github.com/webpack/webpack)
+> [PureScript](http://www.purescript.org) loader for [webpack](http://webpack.github.io)
 
 ## Install
 
@@ -12,8 +12,6 @@ npm install purs-loader --save-dev
 
 ## Options
 
-#### options
-
  - **no-prelude**: Boolean value that toggles `--no-prelude`
   - Do not include the Prelude in the generated Javascript.
  - **no-opts**: Boolean value that toggles `--no-opts`
@@ -22,8 +20,6 @@ npm install purs-loader --save-dev
   - Turn off optimizations which inline calls to >>= for the Eff monad.
  - **no-tco**: Boolean value that toggles `--no-tco`
   - Turn off tail-call elimination.
- - **runtime-type-checks**: Boolean value that toggles `--runtime-type-checks`
-  - Generate simple runtime type checks for function arguments with simple types.
  - **verbose-errors**: Boolean value that toggles `--verbose-errors`
   - Generate verbose error messages.
  - **output**: String value that sets `--output=<string>`
@@ -31,27 +27,4 @@ npm install purs-loader --save-dev
 
 ## Example
 
-```js
-var path = require('path');
-
-module.exports = {
-  entry: './src/test',
-  output: {
-    path: path.join(__dirname, 'dist'),
-    filename: 'app.js'
-  },
-  module: {
-    loaders: [{
-      test: /\.purs$/,
-      loader: 'purs-loader?no-prelude&output=output'
-    }]
-  },
-  resolve: {
-    modulesDirectories: [
-      'node_modules',
-      'web_modules',
-      'output'
-    ]
-  }
-};
-```
+See the [example](https://github.com/ethul/purs-loader/tree/topic/bower-components/example) directory for a complete example.