docs/index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="SketchTool.html">SketchTool</a><ul class='methods'><li data-type='method'><a href="SketchTool.html#exportCall">exportCall</a></li><li data-type='method'><a href="SketchTool.html#getArgs">getArgs</a></li><li data-type='method'><a href="SketchTool.html#listCall">listCall</a></li><li data-type='method'><a href="SketchTool.html#runCommand">runCommand</a></li><li data-type='method'><a href="SketchTool.html#toolOptions">toolOptions</a></li></ul></li></ul>
</nav>
<div id="main">
<section class="readme">
<article><p><a href="https://drone.stackdot.com/stackdot/sketch-tool"><img src="https://drone.stackdot.com/api/badges/stackdot/sketch-tool/status.svg?maxAge=60" alt="Build Status"></a> <a href="https://david-dm.org/stackdot/sketch-tool"><img src="https://img.shields.io/david/stackdot/sketch-tool.svg?maxAge=60" alt="dependencies Status"></a> <a href="https://coveralls.io/github/stackdot/sketch-tool?branch=master"><img src="https://coveralls.io/repos/github/stackdot/sketch-tool/badge.svg?branch=master" alt="Coverage Status"></a></p>
<p><a href="https://codeclimate.com/github/stackdot/sketch-tool"><img src="https://codeclimate.com/github/stackdot/sketch-tool/badges/issue_count.svg" alt="Issue Count"></a> <a href="https://codeclimate.com/github/stackdot/sketch-tool"><img src="https://codeclimate.com/github/stackdot/sketch-tool/badges/gpa.svg" alt="Code Climate"></a></p>
<p><a href="https://www.npmjs.com/package/sketch-tool"><img src="https://img.shields.io/node/v/sketch-tool.svg?maxAge=60" alt="Node Version"></a> <a href="https://www.npmjs.com/package/sketch-tool"><img src="https://img.shields.io/npm/v/sketch-tool.svg?maxAge=60" alt="NPM Version"></a> <a href="https://www.npmjs.com/package/sketch-tool"><img src="https://img.shields.io/npm/l/sketch-tool.svg?maxAge=60" alt="NPM License"></a> </p>
<h1>Sketch Tool</h1><p>Library to use SketchTool CLI tool more easily</p>
<h2>Requirements:</h2><ul>
<li><a href="https://nodejs.org/en/download/">NodeJS</a> ( Version 6+ )<ul>
<li>We recommend using <a href="https://github.com/creationix/nvm">Node Version Manager</a></li>
</ul>
</li>
</ul>
<h2>To Get Started:</h2><ul>
<li>Install the package in your project</li>
</ul>
<pre class="prettyprint source lang-bash"><code>npm install sketch-tool --save</code></pre><p>To use:</p>
<pre class="prettyprint source lang-javascript"><code>
const SketchTool = require('sketch-tool')
const Sketch = new SketchTool({
foo: 'bar'
})</code></pre><p><a href="https://stackdot.github.io/sketch-tool/index.html">JSDocs Documentation</a></p>
<h2>Enabling the Debugger</h2><p>To enable <a href="https://github.com/visionmedia/debug">debug</a> logs, enable them via environment variables.</p>
<p>To see all debug logs from this app, set the env variable:</p>
<pre class="prettyprint source lang-bash"><code>DEBUG=sketch-tool*</code></pre><p>Running with your project:</p>
<pre class="prettyprint source lang-bash"><code>DEBUG=sketch-tool* node myproject.js</code></pre><h2>License</h2><p><a href="http://en.wikipedia.org/wiki/MIT_License">MIT License</a></p></article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Sep 01 2016 13:49:13 GMT-0400 (EDT) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>