Skip to content

Commit 7a04ff5

Browse files
committed
update readme
1 parent 88f061b commit 7a04ff5

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
11
# DynamoDB Toolbox <!-- omit in toc -->
22

3-
[![Build Status](https://travis-ci.org/jeremydaly/dynamodb-toolbox.svg?branch=master)](https://travis-ci.org/jeremydaly/dynamodb-toolbox)
3+
[![Build Status](https://travis-ci.org/jeremydaly/dynamodb-toolbox.svg?branch=main)](https://travis-ci.org/jeremydaly/dynamodb-toolbox)
44
[![npm](https://img.shields.io/npm/v/dynamodb-toolbox.svg)](https://www.npmjs.com/package/dynamodb-toolbox)
55
[![npm](https://img.shields.io/npm/l/dynamodb-toolbox.svg)](https://www.npmjs.com/package/dynamodb-toolbox)
6-
[![Coverage Status](https://coveralls.io/repos/github/jeremydaly/dynamodb-toolbox/badge.svg?branch=master)](https://coveralls.io/github/jeremydaly/dynamodb-toolbox?branch=master)
6+
[![Coverage Status](https://coveralls.io/repos/github/jeremydaly/dynamodb-toolbox/badge.svg?branch=main)](https://coveralls.io/github/jeremydaly/dynamodb-toolbox?branch=master)
77

88
![dynamodb-toolbox](https://user-images.githubusercontent.com/2053544/69847647-b7910780-1245-11ea-8403-a35a0158f3aa.png)
99

1010
## Single Table Designs have never been this easy! <!-- omit in toc -->
1111

1212
The **DynamoDB Toolbox** is a set of tools that makes it easy to work with [Amazon DynamoDB](https://aws.amazon.com/dynamodb/) and the [DocumentClient](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/dynamodb-example-document-client.html). It's designed with **Single Tables** in mind, but works just as well with multiple tables. It lets you define your Entities (with typings and aliases) and map them to your DynamoDB tables. You can then **generate the API parameters** to `put`, `get`, `delete`, `update`, `query`, `scan`, `batchGet`, and `batchWrite` data by passing in JavaScript objects. The DynamoDB Toolbox will map aliases, validate and coerce types, and even write complex `UpdateExpression`s for you. 😉
1313

14+
## Version 0.4 Alpha 🙌
15+
16+
v0.4 is almost ready to be released and supports "Type Inferencing" 😎. Please check out the [v0.4 branch](https://github.com/jeremydaly/dynamodb-toolbox/tree/v0.4) for more information, or you can install the latest alpha version using:
17+
18+
```
19+
20+
```
21+
22+
Feedback is welcome and much appreciated! (Huge thanks to @ThomasAribart for all his work on this 🙌)
23+
1424
## Installation and Basic Usage
1525

1626
Install the DynamoDB Toolbox with npm:
@@ -152,6 +162,7 @@ If you like working with ORMs, that's great, and you should definitely give thes
152162

153163
## Table of Contents <!-- omit in toc -->
154164

165+
- [Version 0.4 Alpha 🙌](#version-04-alpha-)
155166
- [Installation and Basic Usage](#installation-and-basic-usage)
156167
- [Features](#features)
157168
- [Conventions, Motivations, and Migrations from v0.1](#conventions-motivations-and-migrations-from-v01)

0 commit comments

Comments
 (0)