Add install instructions

2017-12-27 17:01:43 -05:00 · 2017-12-27 17:01:43 -05:00 · c4eb8d3c32
parent 7f60fdfb97
commit c4eb8d3c32
1 changed files with 15 additions and 0 deletions
--- a/src/bellows.js
+++ b/src/bellows.js
@ -6,6 +6,21 @@
 * const bellows = require('bellows')
 */

+ /**
+  * ### Install (node.js)
+  *
+  * First, install dependencies required by 
+  * [node-canvas](https://github.com/Automattic/node-canvas) by following 
+  * the [install instructions](https://github.com/Automattic/node-canvas#installation) 
+  * for your OS.
+  *
+  *```
+  * git clone https://github.com/sixteenmillimeter/bellows.git
+  * cd bellows
+  * npm install
+  *```
+  */
+
 const IN = 25.4
 const BLACK = '0,0,0,1.0'