Skip to content

Commit

Permalink
add some comments on README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lengthtail authored and lengthtail committed Mar 26, 2021
1 parent 97954e4 commit 9503067
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,26 @@ A Gatsby source plugin for sourcing data into your Gatsby application from AWS D

## Install

`npm install --save gatsby-source-aws-dynamodb`
`npm install gatsby-source-aws-dynamodb`

## Usage

In your `gatsby-config.js`:
## How to Use

```js
// In your gatsby-config.js
module.exports = {
plugins: [
{
resolve: 'gatsby-source-aws-dynamodb',
options: {
// Arbitrary name for the remote schema Query type
typeName: '<INPUT_GRAPHQL_TYPE_NAME_HERE>',
// It is strongly recommended that credentials are stored in environment variables
accessKeyId: '<AWS_ACCESS_KEY_ID>',
secretAccessKey: '<AWS_SECRET_ACCESS_KEY>',
region: '<AWS_REGION>',
params: {
TableName : "<TABLE_NAME>",
// OTHER PARAMS HERE
// Other params to scan here
}
}
},
Expand Down

0 comments on commit 9503067

Please sign in to comment.