Skip to content

Commit 129bffd

Browse files
authored
Update readme.md
1 parent 02e5245 commit 129bffd

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

micro-s3/readme.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,25 @@ This adds a facility to use AmazonS3Client. The following APIs are provided
1414

1515
See also [micro-async-data-writer](https://github.com/aol/micro-server/tree/master/micro-async-data-writer) and [micro-async-data-loader](https://github.com/aol/micro-server/tree/master/micro-async-data-loader) for automated management of writing versioned data and loading versioned data from S3 (or couchbase via micro-couchbase), that builds on this plugin.
1616

17+
## To use
18+
19+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.aol.microservices/micro-s3/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.aol.microservices/micro-s3)
20+
21+
Simply add to the classpath
22+
23+
Maven
24+
```xml
25+
<dependency>
26+
<groupId>com.aol.microservices</groupId>
27+
<artifactId>micro-s3</artifactId>
28+
<version>x.yz</version>
29+
</dependency>
30+
```
31+
Gradle
32+
```groovy
33+
compile 'com.aol.microservices:micro-s3:x.yz'
34+
```
35+
1736
# Manifest comparison
1837

1938
Manifest comparison stores a manifest along with each value. The manifest contains the version for the value, if the version has changed, the latest verson of the value will be loaded.
@@ -134,7 +153,7 @@ e.g.
134153

135154
```
136155

137-
## DistributedMap
156+
## DistributedMap
138157

139158
Configure the S3 to be used by the DistributedMap with the following property
140159

@@ -158,27 +177,11 @@ Then inject in either DistributedMap or it's concrete implementation S3Distribu
158177
159178
```
160179
161-
## To use
162180
163-
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.aol.microservices/micro-s3/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.aol.microservices/micro-s3)
164-
165-
Simply add to the classpath
166181
167-
Maven
168-
```xml
169-
<dependency>
170-
<groupId>com.aol.microservices</groupId>
171-
<artifactId>micro-s3</artifactId>
172-
<version>x.yz</version>
173-
</dependency>
174-
```
175-
Gradle
176-
```groovy
177-
compile 'com.aol.microservices:micro-s3:x.yz'
178-
```
182+
## Usage AmazonS3Client
179183
180-
## Usage
181-
This plugin simply provides an AmazonS3Client implementation bean. You should define properties for
184+
This plugin also provides an AmazonS3Client implementation bean. You should define properties for
182185
s3.accessKey, s3.secretKey and optionall s3.sessionToken (optionally - only for short term keys)
183186
[AmazonS3Client](http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/AmazonS3Client.html)
184187

0 commit comments

Comments
 (0)