Skip to content

Commit 081eda2

Browse files
author
Felicien
committed
Add usage doc in README
1 parent 898a11c commit 081eda2

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,22 @@ $ npm install swift
1919
Auth3 API will login to your openstack and use a X-Auth-Token in all operations.
2020
Make sure to renew (setInterval) the auth token periodicaly.
2121

22+
## credentials
23+
```js
24+
"use strict";
25+
26+
module.exports = {
27+
authUrl : "https://auth.cloud.ovh.net/v3", // default "https://auth.cloud.ovh.net/v2.0"
28+
keystoneV3 : true, // default false
29+
username : "OpenstackUsername", // required
30+
password : "OpenstackPassword", // required
31+
tenantId : "OpenstackProjectId", // one of tenantId or tenantName is required
32+
tenantName : "OpenstackProjectName", // one of tenantId or tenantName is required
33+
region: "WAW", // default "GRA3"
34+
};
35+
36+
```
37+
2238

2339
## object-store
2440
```js
@@ -68,7 +84,6 @@ module.exports = foo;
6884
Using a container meta-temp key, you can upload, retrieve or delete specific files in your container.
6985
On a CAS designed container, this should be considered as a best practice against a full container access.
7086

71-
7287
## object-store
7388
```js
7489
"use strict";

context.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ class Context {
116116
tenantId : config.tenantId,
117117
tenantName : config.tenantName
118118
}
119-
};
119+
};
120120

121121
var endpoints;
122122
var headers;

0 commit comments

Comments
 (0)