Skip to content
This repository was archived by the owner on May 1, 2020. It is now read-only.

Commit dd64b32

Browse files
committed
Updating README
1 parent c55185f commit dd64b32

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,27 @@ Install with [npm](https://npmjs.org/package/gulp-purescript)
1010
npm install gulp-purescript --save-dev
1111
```
1212

13+
## Binaries
14+
15+
This plugin requires that the PureScript binaries first be installed. The binaries may be installed using the [purescript](https://www.npmjs.com/package/purescript) NPM package or as described on the PureScript [installation](https://github.com/purescript/purescript/wiki/Language-Guide:-Getting-Started#installation) section of the GitHub wiki.
16+
1317
## Example
1418

1519
```js
16-
var gulp = require('gulp')
17-
, purescript = require('gulp-purescript')
18-
;
20+
var gulp = require('gulp');
21+
22+
var purescript = require('gulp-purescript');
23+
1924
gulp.task('purescript', function(){
20-
return (
21-
gulp.src('src/**/*.purs.hs').
22-
pipe(purescript.psc({noPrelude: true})).
23-
pipe(gulp.dest('dist/'))
24-
);
25+
return gulp.src('src/**/*.purs').
26+
pipe(purescript.psc({noPrelude: true})).
27+
pipe(gulp.dest('build'));
2528
});
2629
```
2730

2831
## API
2932

30-
Refer to the PureScript [usage](http://docs.purescript.org/en/latest/start.html#compiler-usage) section for additional details on the behaviour of each option below.
33+
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.
3134

3235
### purescript.psc(options)
3336

0 commit comments

Comments
 (0)