Skip to content

Commit de8e7ba

Browse files
committed
D-12087 add 2.x and withImplicitAuth notes to README
1 parent a63d79d commit de8e7ba

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![Gitter](https://badges.gitter.im/versionone/VersionOne.SDK.JavaScript.svg)](https://gitter.im/versionone/VersionOne.SDK.JavaScript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
22

3-
# VersionOne JavaScript SDK
3+
# VersionOne JavaScript SDK
44

55
The VersionOne JavaScript SDK is an open-source and community supported JavaScript client for the VersionOne API. As an open-sourced and community supported project, the VersionOne JavaScript SDK is not formally supported by VersionOne.
66

@@ -17,8 +17,9 @@ The source code for the VersionOne JavaScript SDK is free and open-source, and w
1717
# Getting Started
1818

1919
Please note:
20-
* 1.x.x SDK is only supported with a VersionOne instance 15.3 or above.
21-
* 1.x.x SDK currently does not support querying for Meta definitions; if this is something needed, please use any 0.x.x
20+
* 2.x.x SDK is only supported with a VersionOne instance 17.1 or later.
21+
* 1.x.x SDK is only supported with a VersionOne instance 15.3-17.0
22+
* 1.x.x SDK currently does not support querying for Meta definitions; if this is something needed, please use any 0.x.x
2223
version.
2324

2425
**See the repo's Wiki for API usage and additional information.**
@@ -31,7 +32,7 @@ version.
3132

3233
The VersionOne application does not currently have an option to enable CORS support. As such, CORS is not supported in our hosted environment. You can still use this JavaScript library for server-side applications.
3334

34-
If you have your own on-premise installation, open the VersionOne `Web.config` file and add the three entires
35+
If you have your own on-premise installation, open the VersionOne `Web.config` file and add the three entires
3536
after the `<add name="VersionOne" ... />` entry:
3637

3738
```xml
@@ -58,6 +59,7 @@ const jqueryConnectedSdk = jqueryConnector($)(sdk);
5859
const v1 = jqueryConnectedSdk('www14.v1host.com', 'v1sdktesting', 443, true)
5960
.withCreds('admin', 'admin'); // usage with username/password
6061
// .withAccessToken('your token'); // usage with access tokens
62+
// .withImplicitAuth(); // let the browser do its thing
6163

6264
v1.create('Story', {estimate: 5, status: 'Not Started'})
6365
.then((story) => v1.update(story.oidToken, {estimate: 7}))

0 commit comments

Comments
 (0)