Skip to content

Commit

Permalink
Merge pull request #67 from AdrieanKhisbe/readme-improvments
Browse files Browse the repository at this point in the history
Readme improvments
  • Loading branch information
aaronshaf committed Nov 9, 2018
2 parents 6a267e7 + dade5a3 commit 7030c9c
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
GUI for [DynamoDB Local](https://aws.amazon.com/blogs/aws/dynamodb-local-for-desktop-development/) or [dynalite](https://github.com/mhart/dynalite).
# dynamodb-admin

[![npm](https://img.shields.io/npm/v/dynamodb-admin.svg)](https://www.npmjs.com/package/dynamodb-admin)
[![CircleCI (all branches)](https://img.shields.io/circleci/project/github/aaronshaf/dynamodb-admin.svg)](https://circleci.com/gh/aaronshaf/dynamodb-admin)

> GUI for [DynamoDB Local](https://aws.amazon.com/blogs/aws/dynamodb-local-for-desktop-development/) or [dynalite](https://github.com/mhart/dynalite).
## Usage

Expand All @@ -16,6 +21,14 @@ Options:

You can also specify port to run on by setting environment variable `PORT` to given number. This will override value specified on the command line. This is legacy way to specify PORT.

If you use a local dynamodb that cares about credentials, you can configure them by using the following environment variables `AWS_REGION` `AWS_ACCESS_KEY_ID` `AWS_SECRET_ACCESS_KEY`

For example with the `amazon/dynamodb-local` docker image you can launch `dynamodb-admin` with:

```bash
AWS_REGION=eu-west-1 AWS_ACCESS_KEY_ID=local AWS_SECRET_ACCESS_KEY=local dynamodb-admin
```

### Use as a library in your project

```
Expand Down

0 comments on commit 7030c9c

Please sign in to comment.