Update README and docs

Author: hdgarrood

README.md

@@ -1,102 +1,5 @@
-# Module Documentation
+# purescript-node-buffer
 
-## Module Node.Buffer
+Type declarations and FFI wrappers for Node's Buffer class.
 
-### Types
-
-    data Buffer :: *
-
-    data BufferValueType where
-      UInt8 :: BufferValueType
-      UInt16LE :: BufferValueType
-      UInt16BE :: BufferValueType
-      UInt32LE :: BufferValueType
-      UInt32BE :: BufferValueType
-      Int8 :: BufferValueType
-      Int16LE :: BufferValueType
-      Int16BE :: BufferValueType
-      Int32LE :: BufferValueType
-      Int32BE :: BufferValueType
-      FloatLE :: BufferValueType
-      FloatBE :: BufferValueType
-      DoubleLE :: BufferValueType
-      DoubleBE :: BufferValueType
-
-    data BufferWrite :: !
-
-    type Octet  = Number
-
-    type Offset  = Number
-
-
-### Type Class Instances
-
-    instance showBuffer :: Show Buffer
-
-    instance showBufferValueType :: Show BufferValueType
-
-
-### Values
-
-    concat :: [Buffer] -> Buffer
-
-    concat' :: [Buffer] -> Number -> Buffer
-
-    copy :: Offset -> Offset -> Buffer -> Offset -> Buffer -> Buffer
-
-    create :: Number -> Buffer
-
-    fill :: forall e. Octet -> Offset -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit
-
-    fromArray :: [Octet] -> Buffer
-
-    fromString :: String -> Encoding -> Buffer
-
-    getAtOffset :: Offset -> Buffer -> Maybe Octet
-
-    read :: BufferValueType -> Offset -> Buffer -> Number
-
-    readString :: forall e. Encoding -> Offset -> Offset -> Buffer -> String
-
-    setAtOffset :: forall e. Octet -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit
-
-    size :: forall e. Buffer -> Number
-
-    toArray :: Buffer -> [Octet]
-
-    toString :: forall e. Encoding -> Buffer -> String
-
-    write :: forall e. BufferValueType -> Number -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit
-
-    writeString :: forall e. Encoding -> Offset -> Number -> String -> Buffer -> Eff (buffer :: BufferWrite | e) Number
-
-
-## Module Node.Buffer.Unsafe
-
-### Values
-
-    slice :: Offset -> Offset -> Buffer -> Buffer
-
-
-## Module Node.Encoding
-
-### Types
-
-    data Encoding where
-      ASCII :: Encoding
-      UTF8 :: Encoding
-      UTF16LE :: Encoding
-      UCS2 :: Encoding
-      Base64 :: Encoding
-      Binary :: Encoding
-      Hex :: Encoding
-
-
-### Type Class Instances
-
-    instance showEncoding :: Show Encoding
-
-
-### Values
-
-    byteLength :: String -> Encoding -> Number
+[Module documentation](docs/)

docs/Node/Buffer.md

@@ -0,0 +1,153 @@
+## Module Node.Buffer
+
+#### `Octet`
+
+``` purescript
+type Octet = Number
+```
+
+#### `Offset`
+
+``` purescript
+type Offset = Number
+```
+
+#### `Buffer`
+
+``` purescript
+data Buffer :: *
+```
+
+##### Instances
+``` purescript
+instance showBuffer :: Show Buffer
+```
+
+#### `BufferWrite`
+
+``` purescript
+data BufferWrite :: !
+```
+
+#### `BufferValueType`
+
+``` purescript
+data BufferValueType
+  = UInt8
+  | UInt16LE
+  | UInt16BE
+  | UInt32LE
+  | UInt32BE
+  | Int8
+  | Int16LE
+  | Int16BE
+  | Int32LE
+  | Int32BE
+  | FloatLE
+  | FloatBE
+  | DoubleLE
+  | DoubleBE
+```
+
+##### Instances
+``` purescript
+instance showBufferValueType :: Show BufferValueType
+```
+
+#### `create`
+
+``` purescript
+create :: Int -> Buffer
+```
+
+#### `fromArray`
+
+``` purescript
+fromArray :: Array Octet -> Buffer
+```
+
+#### `fromString`
+
+``` purescript
+fromString :: String -> Encoding -> Buffer
+```
+
+#### `read`
+
+``` purescript
+read :: BufferValueType -> Offset -> Buffer -> Number
+```
+
+#### `readString`
+
+``` purescript
+readString :: forall e. Encoding -> Offset -> Offset -> Buffer -> String
+```
+
+#### `toString`
+
+``` purescript
+toString :: forall e. Encoding -> Buffer -> String
+```
+
+#### `write`
+
+``` purescript
+write :: forall e. BufferValueType -> Number -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit
+```
+
+#### `writeString`
+
+``` purescript
+writeString :: forall e. Encoding -> Offset -> Number -> String -> Buffer -> Eff (buffer :: BufferWrite | e) Number
+```
+
+#### `toArray`
+
+``` purescript
+toArray :: Buffer -> Array Octet
+```
+
+#### `getAtOffset`
+
+``` purescript
+getAtOffset :: Offset -> Buffer -> Maybe Octet
+```
+
+#### `setAtOffset`
+
+``` purescript
+setAtOffset :: forall e. Octet -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit
+```
+
+#### `size`
+
+``` purescript
+size :: Buffer -> Number
+```
+
+#### `concat`
+
+``` purescript
+concat :: Array Buffer -> Buffer
+```
+
+#### `concat'`
+
+``` purescript
+concat' :: Array Buffer -> Number -> Buffer
+```
+
+#### `copy`
+
+``` purescript
+copy :: Offset -> Offset -> Buffer -> Offset -> Buffer -> Buffer
+```
+
+#### `fill`
+
+``` purescript
+fill :: forall e. Octet -> Offset -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit
+```
+
+

docs/Node/Buffer/Unsafe.md

@@ -0,0 +1,9 @@
+## Module Node.Buffer.Unsafe
+
+#### `slice`
+
+``` purescript
+slice :: Offset -> Offset -> Buffer -> Buffer
+```
+
+

docs/Node/Encoding.md

@@ -0,0 +1,27 @@
+## Module Node.Encoding
+
+#### `Encoding`
+
+``` purescript
+data Encoding
+  = ASCII
+  | UTF8
+  | UTF16LE
+  | UCS2
+  | Base64
+  | Binary
+  | Hex
+```
+
+##### Instances
+``` purescript
+instance showEncoding :: Show Encoding
+```
+
+#### `byteLength`
+
+``` purescript
+byteLength :: String -> Encoding -> Number
+```
+
+