Skip to content

Commit 0356ffa

Browse files
committed
update readme for maven deppendency
1 parent ddfd298 commit 0356ffa

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This library requires Apache Spark 1.4+, Scala 2.10.4+, Jedis 2.7+, Redis 3.0+
1313
## Current Limitations
1414
* No Java or Python API bindings
1515
* Only tested with the following configurations:
16-
- Redis 3.0
16+
- Redis 2.8+
1717
- Scala 2.10
1818
- Spark 1.4.0
1919
- Jedis 2.7
@@ -30,6 +30,27 @@ after the `git clone` in **Using the library** field
3030
* The APIs will probably change several times before an official release
3131

3232
## Using the library
33+
There are two ways of using Spark-Redis library:
34+
35+
You can use it as a maven dependency:
36+
```
37+
<repositories>
38+
<repository>
39+
<id>spark-redis-mvn-repo</id>
40+
<url>https://raw.github.com/RedisLabs/spark-redis/mvn-repo/</url>
41+
</repository>
42+
</repositories>
43+
44+
<dependencies>
45+
<dependency>
46+
<groupId>com.redislabs</groupId>
47+
<artifactId>spark-redis</artifactId>
48+
<version>0.5.1</version>
49+
</dependency>
50+
</dependencies>
51+
```
52+
53+
There also exists the possibility of downloading the project by doing:
3354
```
3455
git clone https://github.com/RedisLabs/spark-redis.git
3556
mvn clean install
@@ -52,9 +73,9 @@ Type in expressions to have them evaluated.
5273
Type :help for more information.
5374
...
5475
```
55-
To read data from Redis Cluster, you can use the library by loading the implicits from `com.redislabs.provider.redis._` .
76+
To read data from Redis Server, you can use the library by loading the implicits from `com.redislabs.provider.redis._` .
5677

57-
In the example we can see how to read from Redis Cluster.
78+
In the example we can see how to read from Redis Server.
5879
```
5980
scala> import com.redislabs.provider.redis._
6081
scala> val keysRDD = sc.fromRedisKeyPattern(("127.0.0.1", 7000), "*", 5)
@@ -65,7 +86,7 @@ scala> val listRDD = keysRDD.getList
6586
scala> val setRDD = keysRDD.getSet
6687
```
6788

68-
In the example we can see how to write to Redis Cluster.
89+
In the example we can see how to write to Redis Server.
6990
```
7091
scala> import import com.redislabs.provider.redis._
7192
scala> val keysRDD = sc.fromRedisKeyPattern(("127.0.0.1", 7000), "*", 5)

0 commit comments

Comments
 (0)