Skip to content

Commit 95b3930

Browse files
authored
Merge pull request johnpduane#16 from blimmer/patch-1
Update documentation to include REST API Token information
2 parents 2358236 + 9bb1b1d commit 95b3930

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ Install confluence-api via npm:
77
$ npm install confluence-api
88
```
99

10-
Create an instance of Confluence by providing a username and password (Confluence uses basic http authentication) and a baseUrl used for all future requests. For instance:
10+
Create an instance of Confluence by providing a username and password (or token) and a baseUrl used for all future requests. Confluence uses [basic http authentication](https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/). For instance:
1111
```javascript
1212
var Confluence = require("confluence-api");
1313
var config = {
1414
username: "testuser",
15-
password: "test-user-pw",
15+
password: "test-user-pw-or-rest-api-token",
1616
baseUrl: "https://confluence-api-test.atlassian.net/wiki",
1717
version: 4 // Confluence major version, optional
1818
};
@@ -61,7 +61,7 @@ Construct Confluence.
6161
| --- | --- | --- |
6262
| config | <code>Object</code> | |
6363
| config.username | <code>string</code> | |
64-
| config.password | <code>string</code> | |
64+
| config.password | <code>string</code> | The password or REST API Token for the user ([docs](https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/)) |
6565
| config.baseUrl | <code>string</code> | |
6666
| config.version | <code>number</code> | Optional |
6767

0 commit comments

Comments
 (0)