1
- What is async-dynamo?
2
- =====================
1
+ # async-dynamo
2
+
3
+ ## Overview
4
+
3
5
async-dynamo is an asynchronous scala client for Amazon Dynamo database. It is based on Akka library and provides asynchronous API.
4
6
5
- Quick Start
6
- ===========
7
+ ## Quick Start
8
+
7
9
For detailed information please read [ User Guide] [ user_guide ] .
8
10
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
+
12
15
``` 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 /"
14
17
15
- libraryDependencies += " asyncdynamo" % " async-dynamo" % " 1.6 .0"
18
+ libraryDependencies += " asyncdynamo" % " async-dynamo" % " 1.8 .0"
16
19
```
17
- or for scala 2.9.2
18
20
19
- ```
20
- libraryDependencies += "asyncdynamo" % "async-dynamo" % "1.5.4"
21
- ```
21
+ ### Example
22
22
23
- Example
24
- -------
25
23
``` scala
26
24
27
25
import asyncdynamo ._
@@ -48,8 +46,8 @@ object QuckStart extends App{
48
46
}
49
47
```
50
48
51
- Asynchronous version
52
- --------------------
49
+ ### Asynchronous version
50
+
53
51
``` scala
54
52
val operation = for {
55
53
_ <- Save (julian)
@@ -62,8 +60,8 @@ val operation = for {
62
60
.onComplete{ case _ => dynamo ! ' stop }
63
61
```
64
62
65
- Explicit type class definition
66
- ------------------------------
63
+ ### Explicit type class definition
64
+
67
65
If you need more flexibility when mapping your object to Dynamo table you can define the type class yourself, i.e.
68
66
``` scala
69
67
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
79
77
}
80
78
```
81
79
82
- Documentation
83
- =============
80
+ ## Documentation
81
+
84
82
For detailed information please read [ User Guide] [ user_guide ] .
85
83
86
- Information for developers
87
- ==========================
84
+ ## Information for developers
85
+
86
+ ### Building
88
87
89
- Building
90
- --------
91
88
This library is build with SBT.
92
89
93
90
### AWS Credentials
91
+
94
92
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.
95
93
The easiest way to do this is to add them to SBT_OPTS variable, i.e.
96
94
@@ -100,20 +98,22 @@ To build async-dynamo run:
100
98
101
99
sbt clean test
102
100
103
- IntelliJ and SBT
104
- ----------------
101
+ ### IntelliJ and SBT
102
+
105
103
Generating IntelliJ project files:
106
104
107
105
sbt gen-idea
108
106
109
107
_ IMPORTANT: You need to run ` sbt gen-idea ` every time you change the dependencies._
108
+
110
109
If you want to refresh the snapshot dependencies (WHICH I TRY TO AVOID) run:
111
110
112
111
sbt clean update
112
+
113
113
Click on Synchronize icon in IntelliJ - it should pick it up.
114
114
115
- VERSIONING
116
- ----------
115
+ ## Versioning
116
+
117
117
major.minor.patch-SNAPSHOT
118
118
ie.
119
119
0.12.1
@@ -125,14 +125,28 @@ Otherwise please bump the minor version.
125
125
126
126
Please do not depend on SNAPSHOTs as they promote chaos and lack of determinism.
127
127
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.
131
131
It is much easier to apply this policy to the library.
132
132
133
133
In order to release a new version:
134
134
- run ` sbt release `
135
135
- confirm or amend the release version
136
136
- confirm next development version
137
137
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
+
138
151
[ user_guide ] : doc/user_guide.md " User Guide "
152
+ [ license ] : http://www.apache.org/licenses/LICENSE-2.0
0 commit comments