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

Commit 02d5dec

Browse files
committed
release notes update
1 parent f29c57e commit 02d5dec

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Paperspace API (v0.1.5)
1+
# Paperspace API (v0.1.6)
22

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

@@ -15,6 +15,42 @@ 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.6
19+
20+
#### 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.
22+
* New methods for early access to jobs. Please contact hello@paperspace.com for more information.
23+
24+
#### Breaking Changes
25+
*BREAKING CHANGE #1* (for Nodejs apps which use the paperspace-node module):
26+
27+
In previous versions (up to 0.1.5) paperspace-node methods returned an HTTP response object on success, and application code needed
28+
to dereference through the HTTP response body object to get attributes of the returned object.
29+
For example, when getting the name of a machine you would have code like this:
30+
```
31+
paperspace.machines.show({ machineId: 'ps123abc' }, function callback(err, resp) {
32+
if (err) return err;
33+
console.log(resp.body.id);
34+
});
35+
```
36+
The new convention is to return the 'body' object directly in the second callback parameter, e.g.:
37+
```
38+
paperspace.machines.show({ machineId: 'ps123abc' }, function callback(err, resp) {
39+
if (err) return err;
40+
console.log(resp.id);
41+
});
42+
```
43+
This change simplifies code that works with the returned objects, and provides better encapsulation. The command line version of the api already followed this convention.
44+
45+
*BREAKING CHANGE #2* (if building the command line app or a custom Nodejs app using the source):
46+
47+
paperspace-node now requires Nodejs 8.9.3 or later. This Node version is specified in the package.json file in the root of the repository.
48+
This change is to support stand-alone binaries of the paperspace-node command line tool that don't require a separate installation of Node.
49+
Previously Node 4.2.3 or later was required, but that version of Node will soon no longer be maintained (after April 2018). You can read more about Node's support cycle here: [Node Releases](https://github.com/nodejs/Release)
50+
51+
#### Fixes
52+
* Minor doc fixes
53+
1854
## Release Notes for v0.1.5
1955

2056
#### New features

0 commit comments

Comments
 (0)