Update docs

Author: hdgarrood

README.md

@@ -1,71 +1,8 @@
-# Module Documentation
-
-## Module Node.ChildProcess
-
-### Types
-
-    newtype ChildProcess where
-      ChildProcess :: ChildProcessRec -> ChildProcess
-
-    type ChildProcessRec  = { disconnect :: forall eff. Fn0 (Eff eff Unit), send :: forall eff r. Fn2 {  | r } Handle (Eff eff Unit), kill :: forall eff. Fn1 Signal Boolean, connected :: Boolean, pid :: Number, stdout :: Stream Stdout, stdin :: Stream Stdin, stderr :: Stream Stderr }
-
-    data Handle :: *
-
-    data Spawn :: !
-
-    type SpawnOptions  = { gid :: Number, uid :: Number, detached :: Boolean, env :: forall r. {  | r }, stdio :: [String], cwd :: String }
-
-    data Stderr :: !
-
-    data Stdin :: !
-
-    data Stdout :: !
-
-    data Stream :: ! -> *
-
-
-### Type Class Instances
-
-    instance eventEmitterChildProcess :: EventEmitter ChildProcess
-
-    instance eventEmitterStreamStderr :: EventEmitter (Stream Stderr)
-
-    instance eventEmitterStreamStdin :: EventEmitter (Stream Stdin)
-
-    instance eventEmitterStreamStdout :: EventEmitter (Stream Stdout)
-
-
-### Values
-
-    closeEvent :: Event
-
-    defaultSpawnOptions :: SpawnOptions
-
-    disconnectEvent :: Event
-
-    errorEvent :: Event
-
-    exitEvent :: Event
-
-    messageEvent :: Event
-
-    process :: forall r. { env :: {  | r } }
-
-    spawn :: forall eff. String -> [String] -> SpawnOptions -> Eff (spawn :: Spawn | eff) ChildProcess
-
-    undefined :: forall a. a
-
-
-## Module Node.ChildProcess.Signal
-
-### Types
-
-    newtype Signal
-
-
-### Type Class Instances
-
-    instance showSignal :: Show Signal
+# purescript-node-child-process
 
+Bindings to Node's `child_process` API.
 
+## Module documentation
 
+* [Node.ChildProcess](docs/Node/ChildProcess.md)
+* [Node.ChildProcess.Signal](docs/Node/ChildProcess/Signal.md)

docs/Node/ChildProcess.md

@@ -0,0 +1,93 @@
+## Module Node.ChildProcess
+
+#### `Handle`
+
+``` purescript
+data Handle :: *
+```
+
+#### `Spawn`
+
+``` purescript
+data Spawn :: !
+```
+
+#### `Stdin`
+
+``` purescript
+data Stdin :: !
+```
+
+#### `Stdout`
+
+``` purescript
+data Stdout :: !
+```
+
+#### `Stderr`
+
+``` purescript
+data Stderr :: !
+```
+
+#### `ChildProcess`
+
+``` purescript
+type ChildProcess = { stderr :: forall eff. Readable () (stderr :: Stderr | eff) String, stdin :: forall eff. Writable () (stdin :: Stdin | eff) String, stdout :: forall eff. Readable () (stdout :: Stdout | eff) String, pid :: Number, connected :: Boolean, kill :: forall eff. Fn1 Signal Boolean, send :: forall eff r. Fn2 {  | r } Handle (Eff eff Unit), disconnect :: forall eff. Fn0 (Eff eff Unit) }
+```
+
+#### `SpawnOptions`
+
+``` purescript
+type SpawnOptions = { cwd :: String, stdio :: Array String, env :: forall r. {  | r }, detached :: Boolean, uid :: Number, gid :: Number }
+```
+
+#### `onExit`
+
+``` purescript
+onExit :: forall eff. ChildProcess -> (Maybe Number -> Maybe Signal -> Eff eff Unit) -> Eff eff Unit
+```
+
+#### `onClose`
+
+``` purescript
+onClose :: forall eff. ChildProcess -> (Maybe Number -> Maybe Signal -> Eff eff Unit) -> Eff eff Unit
+```
+
+#### `onMessage`
+
+``` purescript
+onMessage :: forall eff. ChildProcess -> (Foreign -> Maybe Handle -> Eff eff Unit) -> Eff eff Unit
+```
+
+#### `onDisconnect`
+
+``` purescript
+onDisconnect :: forall eff. ChildProcess -> Eff eff Unit -> Eff eff Unit
+```
+
+#### `onError`
+
+``` purescript
+onError :: forall eff. ChildProcess -> (ChildProcessError -> Eff eff Unit) -> Eff eff Unit
+```
+
+#### `spawn`
+
+``` purescript
+spawn :: forall eff. String -> Array String -> SpawnOptions -> Eff (spawn :: Spawn | eff) ChildProcess
+```
+
+#### `defaultSpawnOptions`
+
+``` purescript
+defaultSpawnOptions :: SpawnOptions
+```
+
+#### `ChildProcessError`
+
+``` purescript
+type ChildProcessError = { code :: String, errno :: String, syscall :: String }
+```
+
+

docs/Node/ChildProcess/Signal.md

@@ -0,0 +1,15 @@
+## Module Node.ChildProcess.Signal
+
+#### `Signal`
+
+``` purescript
+newtype Signal
+  = Signal String
+```
+
+##### Instances
+``` purescript
+Show Signal
+```
+
+