Update build and documentation/readme details

Author: garyb

.gitignore

@@ -1,6 +1,6 @@
 /.*
 !/.gitignore
-bower_components/
-node_modules/
-output/
-tmp/
+!/.travis.yml
+/bower_components/
+/node_modules/
+/output/

.travis.yml

@@ -0,0 +1,15 @@
+language: node_js
+sudo: false
+node_js:
+  - 0.10
+env:
+  - PATH=$HOME/purescript:$PATH
+install:
+  - TAG=$(wget -q -O - https://github.com/purescript/purescript/releases/latest --server-response --max-redirect 0 2>&1 | sed -n -e 's/.*Location:.*tag\///p')
+  - wget -O $HOME/purescript.tar.gz https://github.com/purescript/purescript/releases/download/$TAG/linux64.tar.gz
+  - tar -xvf $HOME/purescript.tar.gz -C $HOME/
+  - chmod a+x $HOME/purescript
+  - npm install bower gulp -g
+  - npm install && bower install
+script:
+  - gulp

README.md

@@ -1,98 +1,18 @@
-# Module Documentation
+# purescript-dom
 
-## Module DOM
+[![Build Status](https://travis-ci.org/purescript-contrib/purescript-dom.svg?branch=master)](https://travis-ci.org/purescript-contrib/purescript-dom)
+[![Maintainer: garyb](https://img.shields.io/badge/maintainer-garyb-lightgrey.svg)](http://github.com/garyb)
 
-#### `DOM`
+Type definitions and standard effect for interacting with the DOM.
 
-``` purescript
-data DOM :: !
-```
-
-Effect type for DOM maniupulation
-
-#### `Node`
-
-``` purescript
-data Node :: *
-```
-
-General type for DOM nodes.
-
-#### `NodeList`
-
-``` purescript
-data NodeList :: *
-```
-
-General type for DOM node lists.
-
-
-## Module DOM.File
-
-
-Types for the [W3C File API](http://dev.w3.org/2006/webapi/FileAPI/).
-
-#### `File`
-
-``` purescript
-data File :: *
-```
-
-A `File` object instance.
-
-#### `FileList`
-
-``` purescript
-data FileList :: *
-```
-
-A `FileList` object instance.
+## Installation
 
-#### `FileReader`
-
-``` purescript
-data FileReader :: *
-```
-
-A `FileReader` object instance.
-
-#### `Blob`
-
-``` purescript
-data Blob :: *
-```
-
-A `Blob` object instance.
-
-
-## Module DOM.XHR
-
-
-Types for the [WHATWG XMLHttpRequest Living Standard](https://xhr.spec.whatwg.org/#interface-formdata).
-
-#### `XMLHttpRequest`
-
-``` purescript
-data XMLHttpRequest :: *
 ```
-
-An `XMLHttpRequest` object instance.
-
-#### `FormData`
-
-``` purescript
-data FormData :: *
+bower install purescript-dom
 ```
 
-A `FormData` object instance.
-
-#### `ProgressEvent`
-
-``` purescript
-data ProgressEvent :: *
-```
-
-A `ProgressEvent` object instance.
-
-
+## Module documentation
 
+- [DOM](docs/DOM.md)
+- [DOM.File](docs/DOM.File.md)
+- [DOM.XHR](docs/DOM.XHR.md)

bower.json

@@ -1,5 +1,22 @@
 {
   "name": "purescript-dom",
-  "description": "PureScript interface for the DOM.",
-  "license": "MIT"
+  "homepage": "https://github.com/purescript-contrib/purescript-dom",
+  "description": "PureScript type definitions and effect for interacting with the DOM",
+  "keywords": [
+    "purescript"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/purescript-contrib/purescript-dom.git"
+  },
+  "ignore": [
+    "**/.*",
+    "bower_components",
+    "node_modules",
+    "output",
+    "bower.json",
+    "gulpfile.js",
+    "package.json"
+  ]
 }

docs/DOM.File.md

@@ -0,0 +1,37 @@
+## Module DOM.File
+
+Types for the [W3C File API](http://dev.w3.org/2006/webapi/FileAPI/).
+
+#### `File`
+
+``` purescript
+data File :: *
+```
+
+A `File` object instance.
+
+#### `FileList`
+
+``` purescript
+data FileList :: *
+```
+
+A `FileList` object instance.
+
+#### `FileReader`
+
+``` purescript
+data FileReader :: *
+```
+
+A `FileReader` object instance.
+
+#### `Blob`
+
+``` purescript
+data Blob :: *
+```
+
+A `Blob` object instance.
+
+

docs/DOM.XHR.md

@@ -0,0 +1,29 @@
+## Module DOM.XHR
+
+Types for the [WHATWG XMLHttpRequest Living Standard](https://xhr.spec.whatwg.org/#interface-formdata).
+
+#### `XMLHttpRequest`
+
+``` purescript
+data XMLHttpRequest :: *
+```
+
+An `XMLHttpRequest` object instance.
+
+#### `FormData`
+
+``` purescript
+data FormData :: *
+```
+
+A `FormData` object instance.
+
+#### `ProgressEvent`
+
+``` purescript
+data ProgressEvent :: *
+```
+
+A `ProgressEvent` object instance.
+
+

docs/DOM.md

@@ -0,0 +1,35 @@
+## Module DOM
+
+#### `DOM`
+
+``` purescript
+data DOM :: !
+```
+
+Effect type for DOM maniupulation
+
+#### `Document`
+
+``` purescript
+data Document :: *
+```
+
+General type for DOM documents.
+
+#### `Node`
+
+``` purescript
+data Node :: *
+```
+
+General type for DOM nodes.
+
+#### `NodeList`
+
+``` purescript
+data NodeList :: *
+```
+
+General type for DOM node lists.
+
+

gulpfile.js

@@ -1,27 +1,49 @@
+/* jshint node: true */
 "use strict";
 
 var gulp = require("gulp");
-var plumber = require("gulp-plumber");
 var purescript = require("gulp-purescript");
-var jsvalidate = require("gulp-jsvalidate");
+var rimraf = require("rimraf");
+
+var sources = [
+  "src/**/*.purs",
+  "bower_components/purescript-*/src/**/*.purs"
+];
+
+var foreigns = [
+  "src/**/*.js",
+  "bower_components/purescript-*/src/**/*.js"
+];
+
+gulp.task("clean-docs", function (cb) {
+  rimraf("docs", cb);
+});
+
+gulp.task("clean-output", function (cb) {
+  rimraf("output", cb);
+});
+
+gulp.task("clean", ["clean-docs", "clean-output"]);
 
 gulp.task("make", function() {
-  return gulp.src(["src/**/*.purs", "bower_components/purescript-*/src/**/*.purs"])
-    .pipe(plumber())
-    .pipe(purescript.pscMake());
+  return gulp.src(sources)
+    .pipe(purescript.pscMake({ ffi: foreigns }));
 });
 
-gulp.task("jsvalidate", ["make"], function () {
-  return gulp.src("output/**/*.js")
-    .pipe(plumber())
-    .pipe(jsvalidate());
+gulp.task("docs", ["clean-docs"], function () {
+  return gulp.src(sources)
+    .pipe(purescript.pscDocs({
+      docgen: {
+        "DOM": "docs/DOM.md",
+        "DOM.File": "docs/DOM.File.md",
+        "DOM.XHR": "docs/DOM.XHR.md"
+      }
+    }));
 });
 
-gulp.task("docs", function () {
-  return gulp.src("src/**/*.purs")
-    .pipe(plumber())
-    .pipe(purescript.pscDocs())
-    .pipe(gulp.dest("README.md"));
+gulp.task("dotpsci", function () {
+  return gulp.src(sources)
+    .pipe(purescript.dotPsci());
 });
 
-gulp.task("default", ["jsvalidate", "docs"]);
+gulp.task("default", ["make", "docs", "dotpsci"]);

package.json

@@ -2,8 +2,7 @@
   "private": true,
   "devDependencies": {
     "gulp": "^3.8.11",
-    "gulp-jsvalidate": "^1.0.1",
-    "gulp-plumber": "^1.0.0",
-    "gulp-purescript": "^0.1.2"
+    "gulp-purescript": "^0.5.0-rc.1",
+    "rimraf": "^2.3.3"
   }
 }