From a42f24b85a304e128c45003b806cc5c4d551b3af Mon Sep 17 00:00:00 2001
From: eric thul <thul.eric@gmail.com>
Date: Sun, 21 Sep 2014 12:50:12 -0400
Subject: Implementation of the loader

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..17fe735
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# purs-loader
+
+> [PureScript](http://www.purescript.org) loader for [webpack](https://github.com/webpack/webpack)
+
+## Install
+
+Install with [npm](https://npmjs.org/package/purs-loader)
+
+```
+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`
+  - Disable all optimizations.
+ - **no-magic-do**: Boolean value that toggles `--no-magic-do`
+  - 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>`
+  - Write the generated Javascript to the specified file.
+
+## 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'
+    ]
+  }
+};
+```
-- 
cgit v1.2.3