Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
anandsas committed Jun 25, 2018
1 parent 811b641 commit 943d349
Showing 1 changed file with 69 additions and 2 deletions.
71 changes: 69 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,73 @@
## AWS DAX SDK for Go
# AWS DAX SDK for Go

AWS DAX SDK for the Go programming language. https://aws.amazon.com/dynamodb/dax
aws-dax-go is the official AWS DAX SDK for the Go programming language. https://aws.amazon.com/dynamodb/dax

Checkout our [release notes](https://github.com/aws/aws-dax-go/releases) for
information about the latest bug fixes, updates, and features added to the SDK.

## Getting started
The best way to get started working with the SDK is to use go get to add the SDK
to your Go Workspace manually.

go get github.com/aws/aws-dax-go

You could also use [Dep](https://github.com/golang/dep) to add the SDK to your
application's dependencies. Using Dep will simplify your update story and help
your application keep pinned to a specific version of the SDK.

dep ensure -add github.com/aws/aws-dax-go

## Making API requests
This example shows how you can use the AWS DAX SDK to make an API request.

```go
package main

import (
"fmt"
"github.com/aws/aws-dax-go/dax"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
cfg := dax.DefaultConfig()
cfg.HostPorts = []string{"mycluster.frfx8h.clustercfg.dax.usw2.amazonaws.com:8111"}
cfg.Region = "us-west-2"
client, err := dax.New(cfg)
if err != nil {
panic(fmt.Errorf("unable to initialize client %v", err))
}

input := &dynamodb.PutItemInput{
TableName: aws.String("TryDaxGoTable"),
Item: map[string]*dynamodb.AttributeValue{
"pk": {S: aws.String("mykey")},
"sk": {N: aws.String("0")},
"value": {S: aws.String("myvalue")},
},
}

output, err := client.PutItem(input)
if err != nil {
panic(fmt.Errorf("unable to make request %v", err))
}

fmt.Println("Output: ", output)
}
```

## Feedback and contributing
**GitHub issues:** To provide feedback or report bugs, file GitHub
[Issues](https://github.com/aws/aws-dax-go/issues) on the SDK.
This is the preferred mechanism to give feedback so that other users can engage in
the conversation, +1 issues, etc. Issues you open will be evaluated, and included
in our roadmap.

**Contributing:** You can open pull requests for fixes or additions to the
AWS DAX SDK for Go. All pull requests must be submitted under the Apache 2.0
license and will be reviewed by an SDK team member before being merged in.
Accompanying unit tests, where possible, are appreciated.

## License

Expand Down

0 comments on commit 943d349

Please sign in to comment.