doc update

Author: sanfilip

docs/index.html

@@ -46,7 +46,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="jobs.h
 
 
     <section class="readme">
-        <article><h1>Paperspace API (v0.1.6)</h1><p><img src="https://user-images.githubusercontent.com/585865/27562775-26b8acc6-5a9c-11e7-8270-2b80ca895bc5.png" alt="image"></p>
+        <article><h1>Paperspace API (v0.1.7)</h1><p><img src="https://user-images.githubusercontent.com/585865/27562775-26b8acc6-5a9c-11e7-8270-2b80ca895bc5.png" alt="image"></p>
 <hr>
 <p><strong>Heads up! This project is under construction!</strong> We're offering this early, unstable, pre-alpha release to get early feedback and to see how it might get used in the wild. Use caution: Until we ship a release &gt;= v1.0, expect to encounter bugs, and expect our documentation to be missing or inaccurate in places. We welcome your bug reports and suggestions via GitHub Issues!</p>
 <hr>
@@ -57,8 +57,18 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="jobs.h
 <li><a href="https://paperspace.github.io/paperspace-node">API documentation</a></li>
 <li><a href="scripts.md">Script Guide</a> for creating and using startup scripts</li>
 </ul>
+<h2>Release Notes for v0.1.7</h2><h4>New features</h4><ul>
+<li>New states on returned machine objects: starting, stopping, restarting, serviceready, and upgrading</li>
+<li>Ability to wait on state serviceready when calling machines waitfor method</li>
+<li>New property on returned machine objects: updatesPending</li>
+<li>New releasePublicIp option on machines destroy method</li>
+</ul>
+<h4>Fixes</h4><ul>
+<li>Fix for jobs completing too quickly could cause jobs create output to hang</li>
+<li>Minor doc fixes</li>
+</ul>
 <h2>Release Notes for v0.1.6</h2><h4>New Features</h4><ul>
-<li>Pre-built binaries are now available for <a href="https://s3.amazonaws.com/paperspace-node/v0.1.6/win/paperspace.exe">Windows</a>, <a href="https://s3.amazonaws.com/paperspace-node/v0.1.6/mac/paperspace">Mac</a>, and <a href="https://s3.amazonaws.com/paperspace-node/v0.1.6/linux/paperspace">Linux</a>.  These binaries enable you to run the paperspace-node command line tool without having to install Nodejs or any additional node modules.</li>
+<li>Pre-built binaries are now available for Windows, Mac, and Linux.  These binaries enable you to run the paperspace-node command line tool without having to install Nodejs or any additional node modules.</li>
 <li>New methods for early access to jobs.  Please contact hello@paperspace.com for more information.</li>
 </ul>
 <h4>Breaking Changes</h4><p><em>BREAKING CHANGE #1</em> (for Nodejs apps which use the paperspace-node module):</p>
@@ -116,9 +126,18 @@ <h4>Issues</h4><ul>
 <li>List method exact date searches don't find matches</li>
 <li>List method null value searches don't find matches</li>
 </ul>
-<h2>Getting started</h2><p>Your system will need <a href="https://nodejs.org">Node.js</a> v8+ installed. Check that you have a recent enough version by running <code>node -v</code> in your terminal. Node.js comes bundled with <code>npm</code>, the Node.js package management tool, which you'll use to install this package.</p>
-<h3>Installation</h3><p>Install the package from npm:</p>
-<pre class="prettyprint source"><code>$ npm install -g paperspace-node</code></pre><p>The reason we recommend installing it globally is so the <code>paperspace</code> command will be available on your command line everywhere on your system. If you only want to make it available within an individual Node.js project, you can install it locally by omitting the <code>-g</code> flag.</p>
+<h2>Getting started</h2><h3>Installation</h3><p>Option 1: Install the paperspace-node package from npm:</p>
+<p>For this option your system will need <a href="https://nodejs.org">Node.js</a> v8+ installed. Check that you have a recent enough version by running <code>node -v</code> in your terminal. Node.js comes bundled with <code>npm</code>, the Node.js package management tool, which you'll use to install this package.  Install the package using the -g option as follows:</p>
+<pre class="prettyprint source"><code>$ npm install -g paperspace-node</code></pre><p>The reason we recommend installing it globally is so the <code>paperspace</code> command will be available on your command line everywhere on your system. If you only want to make it available only within an individual Node.js project, you can install it locally by omitting the <code>-g</code> flag.</p>
+<p>Option 2: Download the pre-build binary for your plaftorm:</p>
+<p>Pre-built binaries are available for:</p>
+<ul>
+<li><a href="https://s3.amazonaws.com/paperspace-node/v0.1.7/win/paperspace.exe">Windows</a></li>
+<li><a href="https://s3.amazonaws.com/paperspace-node/v0.1.7/mac/paperspace">Mac</a></li>
+<li><a href="https://s3.amazonaws.com/paperspace-node/v0.1.7/linux/paperspace">Linux</a></li>
+</ul>
+<p>After downloading, make sure the binary is permitted to run on your system by marking is permissions appropriately.
+Also, add the directory containing the paperspace binary to your path using a method appropriate for your platform.</p>
 <h3>Setup</h3><p>Before you can use this tool, you'll need a <a href="https://paperspace.com">Paperspace account</a>. You'll use this account to obtain Paperspace API keys.</p>
 <h3>Obtaining an API key</h3><p>First, sign in to your <a href="https://paperspace.com">Paperspace account</a>. Click 'Launch Console' at top right. From your admin console, you should find an 'Account Info' section. There, you'll find a form where you can create API keys. You'll use the API keys you generate here to authenticate your requests.</p>
 <p><img src="https://user-images.githubusercontent.com/585865/27563650-f2bc289e-5aa0-11e7-990f-4ed6f9bd39e7.png" alt="image"></p>
@@ -155,7 +174,7 @@ <h2>Bugs / Support / Troubleshooting</h2><p>For bugs with the API client, comman
 <h2>Security</h2><p>Think you've discovered a security flaw or exploit? We offer bug bounties for responsible vulnerability disclosures that match our criteria. Please contact us directly at <a href="mailto:support@paperspace.com">support@paperspace.com</a> and we will respond as quickly as we can.</p>
 <h2>Disclaimer</h2><p><strong>Use the Paperspace API with care.</strong> This tool is provided as-is (please see our LICENSE). Know that many actions provided via our public API can result in billing charges for Paperspace services. Please be aware of Paperspace's billing policies before performing any of these actions; you'll see charges reflected in your invoice at the end of the month. Some actions, such as deactivating machines, are irreversible, resulting in permanent loss of data. Paperspace cannot recover lost data such as mistakenly deleted account information, and may only be able to give limited assistance if an action is performed mistakenly. API access will be disabled for accounts not in good standing. Keeping your account credentials secret is your responsibility. You may only use Paperspace's API to store, retrieve, query, serve, and execute content that is owned, licensed or lawfully obtained by you.</p>
 <h2>License</h2><p>This project is open source, under the ISC license. See LICENSE.txt.</p>
-<h2>Copyright</h2><p>Copyright :copyright: 2017 Paperspace - All Rights Reserved</p></article>
+<h2>Copyright</h2><p>Copyright 2018 Paperspace Co. - All Rights Reserved</p></article>
     </section>
 
 
@@ -168,7 +187,7 @@ <h2>Copyright</h2><p>Copyright :copyright: 2017 Paperspace - All Rights Reserved
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 09 2018 02:15:35 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs.html

@@ -2768,7 +2768,7 @@ <h5>Examples</h5>
 
     <pre class="prettyprint"><code># HTTP request:
 https://api.paperspace.io
-GET /jobs/getLogs?jobId=j123abc
+GET /jobs/logs?jobId=j123abc
 x-api-key: 1ba4f98e7c0...
 # Returns 200 on success</code></pre>
 
@@ -3892,7 +3892,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 09 2018 02:15:35 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_artifactsDestroy.js.html

@@ -102,7 +102,7 @@ <h1 class="page-title">jobs/artifactsDestroy.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 09 2018 02:15:35 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_artifactsGet.js.html

@@ -280,7 +280,7 @@ <h1 class="page-title">jobs/artifactsGet.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 09 2018 02:15:35 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_artifactsList.js.html

@@ -133,7 +133,7 @@ <h1 class="page-title">jobs/artifactsList.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 09 2018 02:15:35 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_clone.js.html

@@ -130,7 +130,7 @@ <h1 class="page-title">jobs/clone.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 09 2018 02:15:35 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_create.js.html

@@ -463,7 +463,7 @@ <h1 class="page-title">jobs/create.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 09 2018 02:15:35 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_destroy.js.html

@@ -103,7 +103,7 @@ <h1 class="page-title">jobs/destroy.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 09 2018 02:15:35 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_index.js.html

@@ -68,7 +68,7 @@ <h1 class="page-title">jobs/index.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 09 2018 02:15:35 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/jobs_list.js.html

@@ -156,7 +156,7 @@ <h1 class="page-title">jobs/list.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 09 2018 02:15:35 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>