Skip to content

Commit a59efdf

Browse files
authored
doc: update installation guide for aws v3 (dynamodb-toolbox#583)
1 parent 26b9e34 commit a59efdf

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

docs/docs/introduction/quick-start.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
# Quick Start
22

3-
## Install DynamoDB Toolbox
3+
## Install DynamoDB Toolbox using aws-sdk v3 (>=v0.8.0) (recommended)
4+
5+
Using your favorite package manager, install DynamoDB Toolbox and aws-sdk v3 in your project by running one of the following commands:
6+
7+
```bash
8+
# npm
9+
npm i dynamodb-toolbox
10+
npm install @aws-sdk/lib-dynamodb @aws-sdk/client-dynamodb
11+
12+
# yarn
13+
yarn add dynamodb-toolbox
14+
yarn add @aws-sdk/lib-dynamodb @aws-sdk/client-dynamodb
15+
16+
```
17+
18+
## Install DynamoDB Toolbox using aws-sdk v2 (<v0.8.0)
419

520
Using your favorite package manager, install DynamoDB Toolbox and aws-sdk v2 in your project by running one of the following commands:
621

@@ -14,7 +29,6 @@ yarn add dynamodb-toolbox
1429
yarn add aws-sdk
1530

1631
```
17-
1832
## Add to your code
1933

2034
The `dynamodb-toolbox` package exports `Table` and `Entity` classes. Import or require them into your code as follows:
@@ -30,8 +44,7 @@ import { Table, Entity } from 'dynamodb-toolbox'
3044
## Load the DocumentClient using aws-sdk v3 (>=v0.8.0)
3145

3246
```typescript title="TypeScript"
33-
import { DynamoDB } from '@aws-sdk/client-dynamodb'
34-
import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
47+
import { DynamoDB, DynamoDBClient } from '@aws-sdk/client-dynamodb'
3548
import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
3649

3750
const marshallOptions = {

docs/docs/introduction/what-is-dynamodb-toolbox.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,7 @@ This library **DOES NOT** create DynamoDB Tables for you. You must create the ta
7979
```typescript
8080

8181
// >=v0.8.0
82-
import { DynamoDB } from '@aws-sdk/client-dynamodb'
83-
import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
82+
import { DynamoDB, DynamoDBClient } from '@aws-sdk/client-dynamodb'
8483
import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
8584

8685
const marshallOptions = {

0 commit comments

Comments
 (0)