Skip to content

Commit

Permalink
update readme; add bintray version badge
Browse files Browse the repository at this point in the history
  • Loading branch information
reugn committed Jun 20, 2020
1 parent 3c4c80a commit f0ed354
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,24 @@
# aerospike-client-scala
[![Build Status](https://travis-ci.com/reugn/aerospike-client-scala.svg?branch=master)](https://travis-ci.com/reugn/aerospike-client-scala)
[ ![Download](https://api.bintray.com/packages/reug/maven/aerospike-core/images/download.svg) ](https://bintray.com/reug/maven/aerospike-core/_latestVersion)

Idiomatic and reactive Scala client for [Aerospike](https://www.aerospike.com/) database.

## Modules
* `aerospike-core` provides standard Scala Future and Akka Streams implementation.
* `aerospike-monix` integrates with [Monix](https://monix.io/) library to support Monix effects.
* `aerospike-zio` integrates with [ZIO](https://zio.dev/) library to support ZIO effects.

## Getting started
Add bintray resolver:
```scala
resolvers += Resolver.bintrayRepo("reug", "maven")
```
Add aerospike-core module as a dependency in your project:
```scala
libraryDependencies += "com.github.reugn" %% "aerospike-core" % "<version>"
```
* replace `aerospike-core` with `aerospike-monix` or `aerospike-zio` if required.

## License
Licensed under the [Apache 2.0 License](./LICENSE).

0 comments on commit f0ed354

Please sign in to comment.