Skip to content

Commit 9f05ccb

Browse files
committed
docs(installation): describe how migration records are stored
1 parent 132bec1 commit 9f05ccb

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The DynamoDB Migrations Tool Command Line Interface (CLI)
88

99
## Installation
1010

11-
Make sure you have [AWS-SDK](https://aws.amazon.com/sdk-for-node-js/) installed. Then install the Dynamit CLI to be used in your project with
11+
Make sure you have [AWS-SDK](https://aws.amazon.com/sdk-for-node-js/) installed and configured properly. Then install the Dynamit CLI to be used in your project with
1212

1313
```bash
1414
$ npm install --save-dev dynamit-cli
@@ -20,6 +20,8 @@ And then you should be able to run the CLI with
2020
$ npx dynamit --help
2121
```
2222

23+
Migration records are supposed to be stored in the DynamoDB table with the `table-name` (`"migrations"` by default) and primary key `attribute-name` (`"name"` by default) defined as optional cli options. The tool cannot create the table for you yet, so make sure you created it properly. See [Creating a Table Developer Guide](https://docs.amazonaws.cn/en_us/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.CreateTable)
24+
2325
### Usage
2426

2527
```

0 commit comments

Comments
 (0)