Skip to content
This repository has been archived by the owner on May 9, 2022. It is now read-only.

Commit

Permalink
Less rubbish readme
Browse files Browse the repository at this point in the history
  • Loading branch information
robertberry-zz committed Aug 29, 2014
1 parent 8598511 commit d9a850f
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.markdown
@@ -1,5 +1,18 @@
AWS SDK Scala Wrappers
======================

Provides wrappers for the asynchronous AWS SDK clients, bridging them to Scala
futures.
Provides wrapper classes for the asynchronous clients in the AWS Java
SDK. These provide extra methods that return Scala futures (rather than having
to provide your own callbacks in the `AsyncHandler`).

## Adding as a dependency in SBT

```scala
libraryDependencies += "com.gu" %% "aws-sdk-scala-wrappers" % "0.1"
```

## Usage

Anywhere you're using an asynchronous AWS client, import
`com.gu.awswrappers._`. An implicit class will now be available that wraps the
client and provides extra methods that return Scala futures.

0 comments on commit d9a850f

Please sign in to comment.