From a59efdf0009ba45e0428cab0d193244b2bca5893 Mon Sep 17 00:00:00 2001 From: Josh <61338348+suenalaba@users.noreply.github.com> Date: Sun, 10 Sep 2023 15:26:42 +0800 Subject: [PATCH] doc: update installation guide for aws v3 (#583) --- docs/docs/introduction/quick-start.md | 21 +++++++++++++++---- .../introduction/what-is-dynamodb-toolbox.md | 3 +-- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/docs/introduction/quick-start.md b/docs/docs/introduction/quick-start.md index 8263ec654..f2136a90b 100644 --- a/docs/docs/introduction/quick-start.md +++ b/docs/docs/introduction/quick-start.md @@ -1,6 +1,21 @@ # Quick Start -## Install DynamoDB Toolbox +## Install DynamoDB Toolbox using aws-sdk v3 (>=v0.8.0) (recommended) + +Using your favorite package manager, install DynamoDB Toolbox and aws-sdk v3 in your project by running one of the following commands: + +```bash +# npm +npm i dynamodb-toolbox +npm install @aws-sdk/lib-dynamodb @aws-sdk/client-dynamodb + +# yarn +yarn add dynamodb-toolbox +yarn add @aws-sdk/lib-dynamodb @aws-sdk/client-dynamodb + +``` + +## Install DynamoDB Toolbox using aws-sdk v2 (=v0.8.0) ```typescript title="TypeScript" -import { DynamoDB } from '@aws-sdk/client-dynamodb' -import { DynamoDBClient } from '@aws-sdk/client-dynamodb' +import { DynamoDB, DynamoDBClient } from '@aws-sdk/client-dynamodb' import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb' const marshallOptions = { diff --git a/docs/docs/introduction/what-is-dynamodb-toolbox.md b/docs/docs/introduction/what-is-dynamodb-toolbox.md index 73baae48e..f07875037 100644 --- a/docs/docs/introduction/what-is-dynamodb-toolbox.md +++ b/docs/docs/introduction/what-is-dynamodb-toolbox.md @@ -79,8 +79,7 @@ This library **DOES NOT** create DynamoDB Tables for you. You must create the ta ```typescript // >=v0.8.0 -import { DynamoDB } from '@aws-sdk/client-dynamodb' -import { DynamoDBClient } from '@aws-sdk/client-dynamodb' +import { DynamoDB, DynamoDBClient } from '@aws-sdk/client-dynamodb' import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb' const marshallOptions = {