Skip to content

Commit c46cf16

Browse files
committed
Tidied formatting and added license and copyright to bottom
1 parent e2d472d commit c46cf16

File tree

1 file changed

+46
-32
lines changed

1 file changed

+46
-32
lines changed

README.md

Lines changed: 46 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
1-
What is async-dynamo?
2-
=====================
1+
# async-dynamo
2+
3+
## Overview
4+
35
async-dynamo is an asynchronous scala client for Amazon Dynamo database. It is based on Akka library and provides asynchronous API.
46

5-
Quick Start
6-
===========
7+
## Quick Start
8+
79
For detailed information please read [User Guide][user_guide].
810

9-
SBT
10-
---
11-
Add the following to your build.sbt file for Scala 2.10:
11+
### SBT
12+
13+
Add this to your `built.sbt` file:
14+
1215
```scala
13-
resolvers += "piotrga" at "https://raw.github.com/piotrga/piotrga.github.com/master/maven-repo/"
16+
resolvers += "SnowPlow Repo" at "http://maven.snplow.com/releases/"
1417

15-
libraryDependencies += "asyncdynamo" % "async-dynamo" % "1.6.0"
18+
libraryDependencies += "asyncdynamo" % "async-dynamo" % "1.8.0"
1619
```
17-
or for scala 2.9.2
1820

19-
```
20-
libraryDependencies += "asyncdynamo" % "async-dynamo" % "1.5.4"
21-
```
21+
### Example
2222

23-
Example
24-
-------
2523
```scala
2624

2725
import asyncdynamo._
@@ -48,8 +46,8 @@ object QuckStart extends App{
4846
}
4947
```
5048

51-
Asynchronous version
52-
--------------------
49+
### Asynchronous version
50+
5351
```scala
5452
val operation = for {
5553
_ <- Save(julian)
@@ -62,8 +60,8 @@ val operation = for {
6260
.onComplete{ case _ => dynamo ! 'stop }
6361
```
6462

65-
Explicit type class definition
66-
------------------------------
63+
### Explicit type class definition
64+
6765
If you need more flexibility when mapping your object to Dynamo table you can define the type class yourself, i.e.
6866
```scala
6967
case class Account(id: String, balance: Double, lastModified: Date)
@@ -79,18 +77,18 @@ If you need more flexibility when mapping your object to Dynamo table you can de
7977
}
8078
```
8179

82-
Documentation
83-
=============
80+
## Documentation
81+
8482
For detailed information please read [User Guide][user_guide].
8583

86-
Information for developers
87-
==========================
84+
## Information for developers
85+
86+
### Building
8887

89-
Building
90-
--------
9188
This library is build with SBT.
9289

9390
### AWS Credentials
91+
9492
In order for tests to be able to connect to Dynamo you have to open Amazon AWS account and pass the AWS credentials to scala via properties.
9593
The easiest way to do this is to add them to SBT_OPTS variable, i.e.
9694

@@ -100,20 +98,22 @@ To build async-dynamo run:
10098

10199
sbt clean test
102100

103-
IntelliJ and SBT
104-
----------------
101+
### IntelliJ and SBT
102+
105103
Generating IntelliJ project files:
106104

107105
sbt gen-idea
108106

109107
_IMPORTANT: You need to run `sbt gen-idea` every time you change the dependencies._
108+
110109
If you want to refresh the snapshot dependencies (WHICH I TRY TO AVOID) run:
111110

112111
sbt clean update
112+
113113
Click on Synchronize icon in IntelliJ - it should pick it up.
114114

115-
VERSIONING
116-
----------
115+
## Versioning
116+
117117
major.minor.patch-SNAPSHOT
118118
ie.
119119
0.12.1
@@ -125,14 +125,28 @@ Otherwise please bump the minor version.
125125

126126
Please do not depend on SNAPSHOTs as they promote chaos and lack of determinism.
127127

128-
RELEASING
129-
---------
130-
Since we are not expecting many changes in this library we SHOULD not depend on snapshot versions.
128+
## Releasing
129+
130+
Since we are not expecting many changes in this library we **should** not depend on snapshot versions.
131131
It is much easier to apply this policy to the library.
132132

133133
In order to release a new version:
134134
- run `sbt release`
135135
- confirm or amend the release version
136136
- confirm next development version
137137

138+
## Copyright and license
139+
140+
Copyright 2012 2ndlanguage Limited. This product includes software developed at 2ndlanguage Limited.
141+
142+
Licensed under the [Apache License, Version 2.0] [license] (the "License");
143+
you may not use this software except in compliance with the License.
144+
145+
Unless required by applicable law or agreed to in writing, software
146+
distributed under the License is distributed on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
148+
See the License for the specific language governing permissions and
149+
limitations under the License.
150+
138151
[user_guide]: doc/user_guide.md "User Guide"
152+
[license]: http://www.apache.org/licenses/LICENSE-2.0

0 commit comments

Comments
 (0)