Update the docs by running the doc build process.

docs/README.md

@@ -8,6 +8,10 @@
 <dt><a href="#delay">delay(ms)</a> ⇒ <code>Promise</code></dt>
 <dd><p>Delays process for specified amount of time in milliseconds.</p>
 </dd>
+<dt><a href="#log">log()</a></dt>
+<dd><p>Log function wrapper that can silences logs when
+QUIET == true</p>
+</dd>
 <dt><a href="#zeroPad">zeroPad(i, max)</a> ⇒ <code>string</code></dt>
 <dd><p>Pads a numerical value with preceding zeros to make strings same length.</p>
 </dd>
@@ -15,15 +19,18 @@
 <dd><p>Shuffles an array into a random state.</p>
 </dd>
 <dt><a href="#clear">clear()</a></dt>
-<dd><p>Clears the temporary directory of all files. 
+<dd><p>Clears the temporary directory of all files.
     Establishes a directory if none exists.</p>
 </dd>
-<dt><a href="#frames">frames(video, order)</a> ⇒ <code>string</code></dt>
+<dt><a href="#frames">frames(video, order, avconv)</a> ⇒ <code>string</code></dt>
 <dd><p>Exports all frames from video. Appends number to the string
     to keep frames in alternating order to be quickly stitched together
  or re-sorted.</p>
 </dd>
-<dt><a href="#weave">weave(pattern, realtime)</a></dt>
+<dt><a href="#subExec">subExec(cmd)</a></dt>
+<dd><p>Shells out to run a sub command on every frame to perform effects</p>
+</dd>
+<dt><a href="#weave">weave(pattern, realtime, random)</a></dt>
 <dd><p>Re-arranges the frames into the order specified in the pattern.
     Calls <code>patternSort()</code> to perform the rename and unlink actions</p>
 </dd>
@@ -36,7 +43,7 @@
 <dt><a href="#randomSort">randomSort(list, pattern, realtime)</a></dt>
 <dd><p>Ramdomly sort frames for re-stitching.</p>
 </dd>
-<dt><a href="#render">render(output)</a></dt>
+<dt><a href="#render">render(output, avconv)</a></dt>
 <dd><p>Render the frames into a video using ffmpeg.</p>
 </dd>
 <dt><a href="#main">main(arg)</a></dt>
@@ -70,6 +77,13 @@ Delays process for specified amount of time in milliseconds.
 | --- | --- | --- |
 | ms | <code>integer</code> | Milliseconds to delay for |
 
+<a name="log"></a>
+
+## log()
+Log function wrapper that can silences logs when
+QUIET == true
+
+**Kind**: global function  
 <a name="zeroPad"></a>
 
 ## zeroPad(i, max) ⇒ <code>string</code>
@@ -97,13 +111,13 @@ Shuffles an array into a random state.
 <a name="clear"></a>
 
 ## clear()
-Clears the temporary directory of all files. 
+Clears the temporary directory of all files.
 	Establishes a directory if none exists.
 
 **Kind**: global function  
 <a name="frames"></a>
 
-## frames(video, order) ⇒ <code>string</code>
+## frames(video, order, avconv) ⇒ <code>string</code>
 Exports all frames from video. Appends number to the string
 	to keep frames in alternating order to be quickly stitched together
  or re-sorted.
@@ -115,10 +129,22 @@ Exports all frames from video. Appends number to the string
 | --- | --- | --- |
 | video | <code>string</code> | String representing path to video |
 | order | <code>integer</code> | Integer to be appended to pathname of file |
+| avconv | <code>boolean</code> | Whether or not to use avconv instead of ffmpeg |
+
+<a name="subExec"></a>
+
+## subExec(cmd)
+Shells out to run a sub command on every frame to perform effects
+
+**Kind**: global function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| cmd | <code>string</code> | Command to execute on every frame |
 
 <a name="weave"></a>
 
-## weave(pattern, realtime)
+## weave(pattern, realtime, random)
 Re-arranges the frames into the order specified in the pattern.
 	Calls `patternSort()` to perform the rename and unlink actions
 
@@ -128,6 +154,7 @@ Re-arranges the frames into the order specified in the pattern.
 | --- | --- | --- |
 | pattern | <code>array</code> | Pattern of the frames per input |
 | realtime | <code>boolean</code> | Flag to turn on or off realtime behavior (drop frames / number of vids) |
+| random | <code>boolean</code> | Whether or not to randomize frames |
 
 <a name="altSort"></a>
 
@@ -170,7 +197,7 @@ Ramdomly sort frames for re-stitching.
 
 <a name="render"></a>
 
-## render(output)
+## render(output, avconv)
 Render the frames into a video using ffmpeg.
 
 **Kind**: global function  
@@ -178,6 +205,7 @@ Render the frames into a video using ffmpeg.
 | Param | Type | Description |
 | --- | --- | --- |
 | output | <code>string</code> | Path to export the video to |
+| avconv | <code>boolean</code> | Whether or not to use avconv in place of ffmpeg |
 
 <a name="main"></a>