Skip to content
This repository was archived by the owner on Jun 6, 2023. It is now read-only.

Commit 0e83059

Browse files
committed
doc refresh
1 parent 34c8adc commit 0e83059

20 files changed

+32
-31
lines changed

docs/index.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="machin
4646

4747

4848
<section class="readme">
49-
<article><h1>Paperspace API (v0.0.0)</h1><p><img src="https://cloud.githubusercontent.com/assets/585865/26324445/cdeb6658-3f00-11e7-9a18-3e2070d9a400.png" alt="image"></p>
49+
<article><h1>Paperspace API (v0.1.0)</h1><p><img src="https://user-images.githubusercontent.com/585865/27562775-26b8acc6-5a9c-11e7-8270-2b80ca895bc5.png" alt="image"></p>
5050
<hr>
5151
<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>
5252
<hr>
53-
<p>The <strong>Paperspace API</strong> is the official devkit for automating your <a href="https://paperspace.com">Paperspace</a> account. It's currently available in JavaScript, and we plan to offer other languages and integrations in the future. For v0, we are offering basic actions such as creating machines and managing team members. This repo includes:</p>
53+
<p>The <strong>Paperspace API</strong> is the official devkit for automating your <a href="https://www.paperspace.com">Paperspace</a> account. It's currently available in JavaScript, and we plan to offer other languages and integrations in the future. For v0, we are offering basic actions such as creating machines and managing team members. This repo includes:</p>
5454
<ul>
5555
<li><a href="#programmatic">JavaScript API client</a> (for Node.js and the browser)</li>
5656
<li><a href="#cli">CLI</a></li>
@@ -61,6 +61,7 @@ <h3>Installation</h3><p>Install the package from npm:</p>
6161
<pre class="prettyprint source"><code>$ npm install -g Paperspace/paperspace-node#master</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>
6262
<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>
6363
<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>
64+
<p><img src="https://user-images.githubusercontent.com/585865/27563650-f2bc289e-5aa0-11e7-990f-4ed6f9bd39e7.png" alt="image"></p>
6465
<h2>Usage</h2><p>You can interact with Paperspace's API in three ways: programatically (from within JavaScript), from the command line (using the Paperspace CLI), or using an HTTP client of your choice and the Paperspace API HTTP enpoints documented here. The JavaScript libabry and the CLI are backed by the same underlying API client.</p>
6566
<h3>Programmatic</h3><p>We'll be illustrating all examples using <a href="http://speakingjs.com/es5/ch01.html">ES5</a> syntax and the CommonJS module format. For other systems like AMD, consider using a bundler such as Browserify.</p>
6667
<p>Assuming you've installed the <code>paperspace-node</code> package, you can import the package with:</p>
@@ -107,7 +108,7 @@ <h2>Copyright</h2><p>Copyright :copyright: 2017 Paperspace - All Rights Reserved
107108
<br class="clear">
108109

109110
<footer>
110-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
111+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
111112
</footer>
112113

113114
<script>prettyPrint();</script>

docs/machines.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2493,7 +2493,7 @@ <h5>Returns:</h5>
24932493
<br class="clear">
24942494

24952495
<footer>
2496-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2496+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:17 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
24972497
</footer>
24982498

24992499
<script>prettyPrint();</script>

docs/machines_create.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ <h1 class="page-title">machines/create.js</h1>
175175
<br class="clear">
176176

177177
<footer>
178-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
178+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
179179
</footer>
180180

181181
<script>prettyPrint();</script>

docs/machines_destroy.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ <h1 class="page-title">machines/destroy.js</h1>
9898
<br class="clear">
9999

100100
<footer>
101-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
101+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
102102
</footer>
103103

104104
<script>prettyPrint();</script>

docs/machines_index.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ <h1 class="page-title">machines/index.js</h1>
6565
<br class="clear">
6666

6767
<footer>
68-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
68+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
6969
</footer>
7070

7171
<script>prettyPrint();</script>

docs/machines_list.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h1 class="page-title">machines/list.js</h1>
119119
<br class="clear">
120120

121121
<footer>
122-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
122+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
123123
</footer>
124124

125125
<script>prettyPrint();</script>

docs/machines_restart.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h1 class="page-title">machines/restart.js</h1>
9696
<br class="clear">
9797

9898
<footer>
99-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
99+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
100100
</footer>
101101

102102
<script>prettyPrint();</script>

docs/machines_show.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ <h1 class="page-title">machines/show.js</h1>
125125
<br class="clear">
126126

127127
<footer>
128-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
128+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
129129
</footer>
130130

131131
<script>prettyPrint();</script>

docs/machines_start.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h1 class="page-title">machines/start.js</h1>
9696
<br class="clear">
9797

9898
<footer>
99-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
99+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
100100
</footer>
101101

102102
<script>prettyPrint();</script>

docs/machines_stop.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h1 class="page-title">machines/stop.js</h1>
9797
<br class="clear">
9898

9999
<footer>
100-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jun 24 2017 19:53:03 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
100+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Jun 26 2017 22:33:16 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
101101
</footer>
102102

103103
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)