Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wparad authored Dec 31, 2021
1 parent f6067d5 commit d0374d2
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# dynamodb-armor
Drop in replacement for DynamoDB, 100% compatible, protects against common production problems.

[![npm version](https://badge.fury.io/js/dynamodb-armor.svg)](https://badge.fury.io/js/dynamodb-armor)

## Setup
* `npm i --save dynamodb-armor`
* Use the builtin client instead of the one from the AWS SDK.
Expand All @@ -25,7 +27,9 @@ const params = {
}
};

await dynamoDbClient.update(params); // That's right you don't even need the .promise() anymore, or leave it in if you feel like it
// That's right you don't even need the .promise() anymore
// or leave it in if you feel like it.
await dynamoDbClient.update(params);
```

## Here's all the things you don't need to think about
Expand All @@ -38,4 +42,4 @@ await dynamoDbClient.update(params); // That's right you don't even need the .pr
* Don't worry about forgetting to substitute values into the expressions
* Errors always contain parameters and complete documentation of the actual problem, so confusing stack traces or questioning where or why the error happened
* Test mode to easily validate dynamoDB requests in unit tests to ensure the configuration is correct.
* Automatic configuration for best practices from AWS DynamoDB
* Automatic configuration for best practices from AWS DynamoDB

0 comments on commit d0374d2

Please sign in to comment.