From 36c4875d1b664700e36ea8c594d62e76801a9467 Mon Sep 17 00:00:00 2001
From: M McWilliams <hi@mmcwilliams.com>
Date: Wed, 11 Oct 2017 14:00:12 -0700
Subject: [PATCH] Update project readme and a readme file for explaining the
 source.

---
 Readme.md      |  7 +++++--
 docs/Readme.md | 36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+), 2 deletions(-)
 create mode 100644 docs/Readme.md

diff --git a/Readme.md b/Readme.md
index e3a5c59..23c196f 100644
--- a/Readme.md
+++ b/Readme.md
@@ -3,7 +3,7 @@ v2f
 
 Convert video to 16mm-sized strips of frames. For transferring to acetate and other experimental needs.
 
-Look how easy it is to use:
+Use the distributed binary
 
     ./v2f ./path_to_video.mov 300
 
@@ -22,7 +22,7 @@ Releases
 Dependencies
 ------------
 
-- node.js (or use a compiled version)
+- node.js (or use a [released version](https://github.com/sixteenmillimeter/v2f/releases/))
 - libav
 - ImageMagick
 
@@ -37,11 +37,14 @@ Ubuntu
 
 	apt-get install libav imagemagick
 
+
+
 Contribute
 ----------
 
 - Issue Tracker: https://github.com/sixteenmillimeter/v2f/issues
 - Source Code: https://github.com/sixteenmillimeter/v2f
+- Home Page: https://sixteenmillimeter.com/projects/v2f
 
 Support
 -------
diff --git a/docs/Readme.md b/docs/Readme.md
new file mode 100644
index 0000000..e1e1c82
--- /dev/null
+++ b/docs/Readme.md
@@ -0,0 +1,36 @@
+## Functions
+
+<dl>
+<dt><a href="#convert">convert(path, dpi, length)</a></dt>
+<dd><p>Turn video into sheet of images</p>
+</dd>
+<dt><a href="#stitch">stitch(loc, dim)</a></dt>
+<dd><p>Stitch rendered frames into strips</p>
+</dd>
+</dl>
+
+<a name="convert"></a>
+
+## convert(path, dpi, length)
+Turn video into sheet of images
+
+**Kind**: global function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| path | <code>String</code> | file path (absolute) |
+| dpi | <code>Integer</code> | target printing dpi |
+| length | <code>Integer</code> | strip length in frames |
+
+<a name="stitch"></a>
+
+## stitch(loc, dim)
+Stitch rendered frames into strips
+
+**Kind**: global function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| loc | <code>String</code> | Path of folder containing frames |
+| dim | <code>Object</code> | Dimensions object |
+