Skip to content

Commit

Permalink
Add note to use correct version of aws sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
saumehta9 committed Dec 22, 2020
1 parent e5b4efa commit bb8e7ca
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Add support for obtaining basic server-side statistics on individual statement e
* Added `getConsumedIOs(): IOUsage` and `getTimingInformation(): TimingInformation` to the `Result` and `ResultStream`
* `getConsumedIOs(): IOUsage` and `getTimingInformation(): TimingInformation` methods are stateful, meaning the statistics returned by them reflect the state at the time of method execution

#### Note: For using version 2.1.0 and above of the driver, the version of the aws-sdk should be >= 2.815

# 2.0.0 (2020-08-27)

The release candidate 1 (v2.0.0-rc.1) has been selected as a final release of v2.0.0. No new changes are introduced between v2.0.0-rc.1 and v2.0.0.
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Amazon QLDB Node.js Driver

[![NPM Version](https://img.shields.io/badge/npm-v2.0.0-green)](https://www.npmjs.com/package/amazon-qldb-driver-nodejs) [![Documentation](https://img.shields.io/badge/docs-api-green.svg)](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started.nodejs.html)
[![NPM Version](https://img.shields.io/badge/npm-v2.1.0-green)](https://www.npmjs.com/package/amazon-qldb-driver-nodejs) [![Documentation](https://img.shields.io/badge/docs-api-green.svg)](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started.nodejs.html)

This is the Node.js driver for Amazon Quantum Ledger Database (QLDB), which allows Node.js developers to write software that makes use of AmazonQLDB.

Expand Down Expand Up @@ -38,6 +38,8 @@ The driver also has aws-sdk, ion-js and jsbi as peer dependencies. Thus, they mu

```npm install jsbi```

#### Note: For using version 2.1.0 and above of the driver, the version of the aws-sdk should be >= 2.815

Then from within your package, you can now use the driver by importing it. This example shows usage in TypeScript specifying the QLDB ledger name and a specific region:

```javascript
Expand Down

0 comments on commit bb8e7ca

Please sign in to comment.