diff --git a/docs/Readme.md b/docs/Readme.md index e1e1c82..5e90dcd 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -1,36 +1,50 @@ ## Functions
Turn video into sheet of images
+Create image sequence from source video, using
Stitch rendered frames into strips
Object
| object |
+
-## convert(path, dpi, length)
-Turn video into sheet of images
+## convert(input, dpi, length)
+Create image sequence from source video, using
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
-| path | String
| file path (absolute) |
+| input | String
| file path (absolute) |
| dpi | Integer
| target printing dpi |
| length | Integer
| strip length in frames |
-## stitch(loc, dim)
+## stitch(output, dim, next, pageW, pageL)
Stitch rendered frames into strips
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
-| loc | String
| Path of folder containing frames |
+| output | String
| Path of folder containing frames |
| dim | Object
| Dimensions object |
+| next | function
| Async lib callback function |
+| pageW | Integer
| Page width in inches |
+| pageL | Integer
| Page length in inches |
diff --git a/package.json b/package.json
index fb7c0e8..a425843 100644
--- a/package.json
+++ b/package.json
@@ -6,7 +6,8 @@
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"build": "./node_modules/.bin/nexe ./ --build",
- "compile": "./node_modules/.bin/tsc ./src/v2f.ts --outFile ./v2f.js --noImplicitAny --lib ES2017 --lib ES2016 -t ES2016"
+ "compile": "./node_modules/.bin/tsc ./src/v2f.ts --outFile ./v2f.js --noImplicitAny --lib ES2017 --lib ES2016 -t ES2016",
+ "docs": "./node_modules/.bin/jsdoc2md ./v2f.js > ./docs/Readme.md"
},
"author": "mmcwilliams",
"license": "MIT",