From 1cf42ed3d629c27f82cbb99ea8d0cfaa760fc435 Mon Sep 17 00:00:00 2001 From: Filippo Mariotti Date: Sun, 9 Dec 2018 11:23:25 +0000 Subject: [PATCH] Added dependencies and note (#70) * Added dependencies and note * Cleaned up badges * Added published javadoc for fs2 and circe * Added core to the dependencies --- README.md | 27 +++++++++++++++++++++++++-- build.sbt | 2 +- 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9dceb32f..0ad15c5b 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,12 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-core_2.12.svg?label=laserdisc-core&colorB=orange)](https://index.scala-lang.org/laserdisc-io/laserdisc/laserdisc-core) -[![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-core_2.12.svg?label=laserdisc-core-docs&colorB=orange)](https://javadoc.io/doc/io.laserdisc/laserdisc-core_2.12) +[![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-core_2.12.svg?label=laserdisc-core%20docs&colorB=orange)](https://javadoc.io/doc/io.laserdisc/laserdisc-core_2.12) [![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-fs2_2.12.svg?label=laserdisc-fs2&colorB=blue)](https://index.scala-lang.org/laserdisc-io/laserdisc/laserdisc-fs2) -[![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-core_2.12.svg?label=laserdisc-fs2-docs&colorB=blue)](https://javadoc.io/doc/io.laserdisc/laserdisc-fs2_2.12) +[![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-fs2_2.12.svg?label=laserdisc-fs2%20docs&colorB=blue)](https://javadoc.io/doc/io.laserdisc/laserdisc-fs2_2.12) +[![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-circe_2.12.svg?label=laserdisc-circe&colorB=darkgreen)](https://index.scala-lang.org/laserdisc-io/laserdisc/laserdisc-circe) +[![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-circe_2.12.svg?label=laserdisc-circe%20docs&colorB=darkgreen)](https://javadoc.io/doc/io.laserdisc/laserdisc-circe_2.12) +
[![Scala.js](http://scala-js.org/assets/badges/scalajs-0.6.17.svg)](http://scala-js.org) LaserDisc is a(nother) Scala driver for [Redis](https://redis.io/), written in Scala from the ground up. @@ -35,6 +38,8 @@ What's there: What's missing: - [ ] Everything else :) +**Note:** the library is still evolving and more features will be added in the future. Even if the binary compatibility will not be guaranteed until version 1.0.0, the [semantic versioning](https://semver.org/) strategy will be observed in the process. + ### Why the name Two reasons: @@ -140,6 +145,24 @@ This should produce an output similar to the following one: [info] - [ForkJoinPool-3-worker-0] Connection terminated: Right(()) ``` +## Dependencies + +|     | Shapeless | +| ----:| ---------:| +| [![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-core_2.12.svg?label=laserdisc%20core&colorB=orange)](https://index.scala-lang.org/laserdisc-io/laserdisc/laserdisc-core) | 2.3.3 | + +
+ +|     | Fs2 | Log Effect | Laserdisc Core | +| ----:| ---:| ----------:| --------------:| +| [![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-fs2_2.12.svg?label=laserdisc%20fs2&colorB=blue)](https://index.scala-lang.org/laserdisc-io/laserdisc/laserdisc-fs2) | 1.0.2 | 0.4.2 | [![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-core_2.12.svg?label=%20&colorB=orange)](https://index.scala-lang.org/laserdisc-io/laserdisc/laserdisc-core) | + +
+ +|     | Circe | Laserdisc Core | +| ----:| -----:| --------------:| +| [![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-circe_2.12.svg?label=laserdisc%20circe&colorB=darkgreen)](https://index.scala-lang.org/laserdisc-io/laserdisc/laserdisc-circe) | 0.10.1 | [![Maven Central](https://img.shields.io/maven-central/v/io.laserdisc/laserdisc-core_2.12.svg?label=%20&colorB=orange)](https://index.scala-lang.org/laserdisc-io/laserdisc/laserdisc-core) | + ## License LaserDisc is licensed under the **[MIT License](LICENSE)** (the "License"); you may not use this software except in diff --git a/build.sbt b/build.sbt index 49e9d4f5..911b03f7 100644 --- a/build.sbt +++ b/build.sbt @@ -107,7 +107,7 @@ val externalApiMappings = Def.task { } } - (coreDeps.value :+ (scalaOrganization.value % "scala-library" % scalaVersion.value)) + (coreDeps.value ++ fs2Deps.value ++ circeDeps.value :+ (scalaOrganization.value % "scala-library" % scalaVersion.value)) .flatMap(JavaDocIo.maybeDocsFor) .toMap }