Skip to content

Commit c1fa8cf

Browse files
committed
fix: Update readme links and format
1 parent 880b5b5 commit c1fa8cf

File tree

1 file changed

+32
-28
lines changed

1 file changed

+32
-28
lines changed

Readme.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ VisWiz service.
1313

1414
## Installation
1515

16-
Install the SDK module using `npm`:
16+
Install the SDK module using `yarn`:
1717

1818
```
19-
$ npm install -D viswiz-sdk
19+
$ yarn add -D viswiz-sdk
2020
```
2121

22-
or using `yarn`:
22+
Or using `npm`:
2323

2424
```
25-
$ yarn add -D viswiz-sdk
25+
$ npm install -D viswiz-sdk
2626
```
2727

2828
## Usage
@@ -35,18 +35,18 @@ const VisWiz = require('viswiz-sdk');
3535
const client = new VisWiz('your-unique-api-key-here');
3636

3737
client
38-
.getProjects()
39-
.then(projects => projects.find(project => project.name === 'Foo'))
40-
.then(project =>
41-
client.createBuild({
42-
projectID: project.id,
43-
name: 'Foo Bar',
44-
revision: 'abcdef1234567890',
45-
})
46-
)
47-
.then(build =>
48-
client.createImage(build.id, 'image-name', '/path/to/image.png')
49-
);
38+
.getProjects()
39+
.then(projects => projects.find(project => project.name === 'Foo'))
40+
.then(project =>
41+
client.createBuild({
42+
projectID: project.id,
43+
name: 'Foo Bar',
44+
revision: 'abcdef1234567890',
45+
})
46+
)
47+
.then(build =>
48+
client.createImage(build.id, 'image-name', '/path/to/image.png')
49+
);
5050
```
5151

5252
Using `async`/`await`:
@@ -55,33 +55,37 @@ Using `async`/`await`:
5555
const VisWiz = require('viswiz-sdk');
5656

5757
async function run() {
58-
const client = new VisWiz('your-unique-api-key-here');
58+
const client = new VisWiz('your-unique-api-key-here');
5959

60-
const projects = await client.getProjects();
61-
const project = projects.find(project => project.name === 'Foo');
60+
const projects = await client.getProjects();
61+
const project = projects.find(project => project.name === 'Foo');
6262

63-
const build = await client.createBuild({
64-
projectID: project.id,
65-
name: 'Foo Bar',
66-
revision: 'abcdef1234567890',
67-
});
63+
const build = await client.createBuild({
64+
projectID: project.id,
65+
name: 'Foo Bar',
66+
revision: 'abcdef1234567890',
67+
});
6868

69-
await client.createImage(build.id, 'image-name', '/path/to/image.png');
69+
await client.createImage(build.id, 'image-name', '/path/to/image.png');
7070
}
7171

7272
run();
7373
```
7474

7575
## Documentation
7676

77-
See the JSDoc markdown documentation in [Documentation.md](Documentation.md).
77+
See the JSDoc markdown documentation in
78+
[Documentation.md](https://github.com/viswiz-io/viswiz-nodejs-sdk/blob/master/Documentation.md#readme).
7879

7980
## Change log
8081

81-
The change log can be found here: [CHANGELOG.md](CHANGELOG.md).
82+
The change log can be found here:
83+
[CHANGELOG.md](https://github.com/viswiz-io/viswiz-nodejs-sdk/blob/master/CHANGELOG.md#readme).
8284

8385
## Authors and license
8486

8587
Author: [VisWiz.io](https://www.viswiz.io/).
8688

87-
MIT License, see the included [License.md](License.md) file.
89+
MIT License, see the included
90+
[License.md](https://github.com/viswiz-io/viswiz-nodejs-sdk/blob/master/License.md)
91+
file.

0 commit comments

Comments
 (0)