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

Commit d03d6ff

Browse files
committed
update release notes for v0.1.7
1 parent cc3809f commit d03d6ff

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

README.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Paperspace API (v0.1.6)
1+
# Paperspace API (v0.1.7)
22

33
![image](https://user-images.githubusercontent.com/585865/27562775-26b8acc6-5a9c-11e7-8270-2b80ca895bc5.png)
44

@@ -15,10 +15,22 @@ The **Paperspace API** is the official devkit for automating your [Paperspace](h
1515
* [API documentation](https://paperspace.github.io/paperspace-node)
1616
* [Script Guide](scripts.md) for creating and using startup scripts
1717

18+
## Release Notes for v0.1.7
19+
20+
#### New features
21+
* New states on returned machine objects: starting, stopping, restarting, serviceready, and upgrading
22+
* Ability to wait on state serviceready when calling machines waitfor method
23+
* New property on returned machine objects: updatesPending
24+
* New releasePublicIp option on machines destroy method
25+
26+
#### Fixes
27+
* Fix for jobs completing too quickly could cause jobs create output to hang
28+
* Minor doc fixes
29+
1830
## Release Notes for v0.1.6
1931

2032
#### New Features
21-
* Pre-built binaries are now available for [Windows](https://s3.amazonaws.com/paperspace-node/v0.1.6/win/paperspace.exe), [Mac](https://s3.amazonaws.com/paperspace-node/v0.1.6/mac/paperspace), and [Linux](https://s3.amazonaws.com/paperspace-node/v0.1.6/linux/paperspace). These binaries enable you to run the paperspace-node command line tool without having to install Nodejs or any additional node modules.
33+
* 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.
2234
* New methods for early access to jobs. Please contact hello@paperspace.com for more information.
2335

2436
#### Breaking Changes
@@ -97,15 +109,25 @@ Previously Node 4.2.3 or later was required, but that version of Node will soon
97109

98110
## Getting started
99111

100-
Your system will need [Node.js](https://nodejs.org) v8+ installed. Check that you have a recent enough version by running `node -v` in your terminal. Node.js comes bundled with `npm`, the Node.js package management tool, which you'll use to install this package.
101-
102112
### Installation
103113

104-
Install the package from npm:
114+
Option 1: Install the paperspace-node package from npm:
115+
116+
For this option your system will need [Node.js](https://nodejs.org) v8+ installed. Check that you have a recent enough version by running `node -v` in your terminal. Node.js comes bundled with `npm`, the Node.js package management tool, which you'll use to install this package. Install the package using the -g option as follows:
105117

106118
$ npm install -g paperspace-node
107119

108-
The reason we recommend installing it globally is so the `paperspace` 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 `-g` flag.
120+
The reason we recommend installing it globally is so the `paperspace` 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 `-g` flag.
121+
122+
Option 2: Download the pre-build binary for your plaftorm:
123+
124+
Pre-built binaries are available for:
125+
* [Windows](https://s3.amazonaws.com/paperspace-node/v0.1.7/win/paperspace.exe)
126+
* [Mac](https://s3.amazonaws.com/paperspace-node/v0.1.7/mac/paperspace)
127+
* [Linux](https://s3.amazonaws.com/paperspace-node/v0.1.7/linux/paperspace)
128+
129+
After downloading, make sure the binary is permitted to run on your system by marking is permissions appropriately.
130+
Also, add the directory containing the paperspace binary to your path using a method appropriate for your platform.
109131

110132
### Setup
111133

@@ -227,4 +249,4 @@ This project is open source, under the ISC license. See LICENSE.txt.
227249

228250
## Copyright
229251

230-
Copyright :copyright: 2017 Paperspace - All Rights Reserved
252+
Copyright 2018 Paperspace Co. - All Rights Reserved

0 commit comments

Comments
 (0)