Updating the README

Author: ethul

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Eric Thul
+Copyright (c) 2015 Eric Thul
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the

README.md

@@ -32,74 +32,110 @@ gulp.task('purescript', function(){
 
 Refer to the PureScript [compiler usage](https://github.com/purescript/purescript/wiki/Language-Guide:-Getting-Started#compiler-usage) section of the Github wiki for additional details on the behaviour of each option below.
 
-### purescript.psc(options)
-
-Invokes the `psc` command.
-
-#### options
-
- - **noPrelude**: Boolean value that toggles `--no-prelude`
-  -  Do not include the Prelude in the generated Javascript.
- - **noTco**: Boolean value that toggles `--no-tco`
-  - Turn off tail-call elimination.
- - **noMagicDo**: Boolean value that toggles `--no-magic-do`
-  - Turn off optimizations which inline calls to >>= for the Eff monad.
- - **main**: Boolean or string value that sets `--main` or `--main=<string>`
-  - Generate a call to main in the specified module after all other generated Javascript. Defaults to Main if the option is used but no value is provided.
- - **noOpts**: Boolean value that toggles `--no-opts`
-  - Disable all optimizations.
- - **verboseErrors**: Boolean value that toggles `--verbose-errors`
-  - Generate verbose error messages.
- - **comments**: Boolean value that toggles `--comments`
-  - Include comments in generated code.
- - **browserNamespace**: String value that sets `--browser-namespace=<string>`
-  - Specify the namespace that PureScript modules will be exported to when running in the browser.
- - **externs**: String value that sets `--externs=<string>`
-  - Write a list of foreign imports declarations to the specified file in addition to generating Javascript output.
- - **module**: Array of string values that sets one or more `--module=<string>`
-  - If specified, any code which is not referenced transitively from this module will be removed.
- - **codegen**: Array of string values that sets one or more `--codegen=<string>`
-  - A array of modules for which JavaScript and externs should be generated.
- - **output**: String value that specifies the output file. Note that this will not set `--output=<string>` because the resulting file is piped through the Gulp stream.
-  - Write the generated Javascript to the specified file.
- - **noPrefix**: Boolean value that toggles `--no-prefix`
-  - Do not include the comment header.
-
-### purescript.pscMake(options)
-
-Invokes the `psc-make` command.
-
-#### options
-
- - **noPrelude**: Boolean value that toggles `--no-prelude`
-  - Do not include the Prelude in the generated Javascript.
- - **noOpts**: Boolean value that toggles `--no-opts`
-  - Disable all optimizations.
- - **noMagicDo**: Boolean value that toggles `--no-magic-do`
-  - Turn off optimizations which inline calls to >>= for the Eff monad.
- - **noTco**: Boolean value that toggles `--no-tco`
-  - Turn off tail-call elimination.
- - **verboseErrors**: Boolean value that toggles `--verbose-errors`
-  - Generate verbose error messages.
- - **browserNamespace**: String value that sets `--browser-namespace=<string>`
-  - Specify the namespace that PureScript modules will be exported to when running in the browser.
- - **output**: String value that sets `--output=<string>`
-  - Write the generated Javascript to the specified file.
-
-### purescript.pscDocs(options)
-
-Invokes the `pscDocs` command.
-
-#### options
-
- - hierarchy: Boolean value that toggles `--hierarchy-images`
-
-### purescript.dotPsci()
-
-Generates a `.psci` file in the current directory. Each source file is
-added with the `:m` command.
+### `purescript.psc(options)`
+
+Invokes the `psc` command. The following options are supported.
+
+###### `noPrelude` (Boolean)
+
+Toggles `--no-prelude` that omits the Prelude.
+
+###### `noTco` (Boolean)
+
+Toggles `--no-tco` that disables tail-call optimizations.
+
+###### `noMagicDo` (Boolean)
+
+Toggles `--no-magic-do` that disables optimizations overloading the do keyword generating efficient code for the `Eff` monad.
+
+###### `main` (Boolean or String)
+
+Toggles `--main` or sets `--main=<string>` that generates code to run the `main` function in the specified module or the `Main` module by default.
+
+###### `noOpts` (Boolean)
+
+Toggles `--no-opts` that skips the optimization phase.
+
+###### `verboseErrors` (Boolean)
+
+Toggles `--verbose-errors` that displays verbose error messages.
+
+###### `comments` (Boolean)
+
+Toggles `--comments` that includes comments in generated code.
+
+###### `browserNamespace` (String)
+
+Sets `--browser-namespace=<string>` that specifies the namespace that PureScript modules will be exported to when running in the browser.
+
+###### `externs` (String)
+
+Sets `--externs=<string>` that specifies the externs file.
+
+###### `module` (String Array)
+
+Sets one or more `--module=<string>` that enables dead code elimination, removing all code without a transitive dependency of one of the specified modules.
+
+###### `codegen` (String Array)
+
+Sets one or more `--codegen=<string>` that generates code and extenrs for the specified modules.
+
+###### `output` (String)
+
+Sets the path value of the [File](https://github.com/wearefractal/vinyl) passed through the Gulp stream. Note that this will not set `--output=<string>`.
+
+###### `noPrefix` (Boolean)
+
+Toggles `--no-prefix` that does not include the comment header.
+
+### `purescript.pscMake(options)`
+
+Invokes the `psc-make` command. The following options are supported.
+
+###### `noPrelude` (Boolean)
+
+Toggles `--no-prelude` that omits the Prelude.
+
+###### `noTco` (Boolean)
+
+Toggles `--no-tco` that disables tail-call optimizations.
+
+###### `noMagicDo` (Boolean)
+
+Toggles `--no-magic-do` that disables optimizations overloading the do keyword generating efficient code for the `Eff` monad.
+
+###### `noOpts` (Boolean)
+
+Toggles `--no-opts` that skips the optimization phase.
+
+###### `verboseErrors` (Boolean)
+
+Toggles `--verbose-errors` that displays verbose error messages.
+
+###### `comments` (Boolean)
+
+Toggles `--comments` that includes comments in generated code.
+
+###### `output` (String)
+
+Sets `--output=<string>` the specifies the output directory, `output` by default.
+
+###### `noPrefix` (Boolean)
+
+Toggles `--no-prefix` that does not include the comment header.
+
+### `purescript.pscDocs(options)`
+
+Invokes the `pscDocs` command. The following options are supported.
+
+###### `format` (markdown | etags | ctags)
+
+Sets `--output=<markdown|etags|ctags>` that specifies the output format.
+
+### `purescript.dotPsci()`
+
+Generates a `.psci` file in the current directory. Each source file is added with the `:m` command.
 
 ## Command line arguments
 
-The `--verbose` argument will display the output during the `psc-make`
-command. For example `gulp --verbose`.
+The `--verbose` argument will display the output during the `psc-make` command. For example `gulp --verbose`.