From 2f4c77b08444f9732d7c2e392ea228a663991613 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dejan=20Miji=C4=87?= Date: Fri, 17 Mar 2023 09:09:13 +0100 Subject: [PATCH] Update README (#781) --- .github/workflows/site.yml | 8 ++++---- README.md | 21 +++++++++------------ docs/index.md | 21 +++++++++------------ 3 files changed, 22 insertions(+), 28 deletions(-) diff --git a/.github/workflows/site.yml b/.github/workflows/site.yml index 8183620..a9e071b 100644 --- a/.github/workflows/site.yml +++ b/.github/workflows/site.yml @@ -18,7 +18,7 @@ jobs: if: ${{ github.event_name == 'pull_request' }} steps: - name: Git Checkout - uses: actions/checkout@v3.4.0 + uses: actions/checkout@v3.3.0 with: fetch-depth: '0' - name: Setup Scala @@ -41,7 +41,7 @@ jobs: if: ${{ ((github.event_name == 'release') && (github.event.action == 'published')) || (github.event_name == 'workflow_dispatch') }} steps: - name: Git Checkout - uses: actions/checkout@v3.4.0 + uses: actions/checkout@v3.3.0 with: fetch-depth: '0' - name: Setup Scala @@ -65,7 +65,7 @@ jobs: if: ${{ (github.event_name == 'push') || ((github.event_name == 'release') && (github.event.action == 'published')) }} steps: - name: Git Checkout - uses: actions/checkout@v3.4.0 + uses: actions/checkout@v3.3.0 with: ref: ${{ github.head_ref }} fetch-depth: '0' @@ -84,7 +84,7 @@ jobs: git add README.md git commit -m "Update README.md" || echo "No changes to commit" - name: Create Pull Request - uses: peter-evans/create-pull-request@v4.2.4 + uses: peter-evans/create-pull-request@v4.2.3 with: body: |- Autogenerated changes after running the `sbt docs/generateReadme` command of the [zio-sbt-website](https://zio.dev/zio-sbt) plugin. diff --git a/README.md b/README.md index a9904af..c6709b8 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,20 @@ # ZIO Redis -[ZIO Redis](https://github.com/zio/zio-redis) is a ZIO native Redis client. - [![Development](https://img.shields.io/badge/Project%20Stage-Development-green.svg)](https://github.com/zio/zio/wiki/Project-Stages) ![CI Badge](https://github.com/zio/zio-redis/workflows/CI/badge.svg) [![Sonatype Releases](https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-redis_2.13.svg?label=Sonatype%20Release)](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-redis_2.13/) [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-redis_2.13.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-redis_2.13/) [![javadoc](https://javadoc.io/badge2/dev.zio/zio-redis-docs_2.13/javadoc.svg)](https://javadoc.io/doc/dev.zio/zio-redis-docs_2.13) [![ZIO Redis](https://img.shields.io/github/stars/zio/zio-redis?style=social)](https://github.com/zio/zio-redis) ## Introduction -ZIO Redis is in the experimental phase of development, but its goals are: - -- **Type Safety** -- **Performance** -- **Minimum Dependency** -- **ZIO Native** +[ZIO Redis](https://github.com/zio/zio-redis) is a ZIO-native Redis client. +It aims to provide a **type-safe** and **performant** API for accessing Redis +instances. ## Installation -Since the ZIO Redis is in the experimental phase, it is not released yet, but we can use snapshots: +To use ZIO Redis, add the following line to your `build.sbt`: ```scala -libraryDependencies += "dev.zio" %% "zio-redis" % "" +libraryDependencies += "dev.zio" %% "zio-redis" % "0.1.0" ``` ## Example @@ -37,7 +32,7 @@ To run this example we should put following dependencies in our `build.sbt` file ```scala libraryDependencies ++= Seq( - "dev.zio" %% "zio-redis" % "", + "dev.zio" %% "zio-redis" % "0.1.0", "dev.zio" %% "zio-schema-protobuf" % "0.3.0" ) ``` @@ -71,7 +66,9 @@ object ZIORedisExample extends ZIOAppDefault { To test you can use the embedded redis instance by adding to your build: -```libraryDependencies := "dev.zio" %% "zio-redis-embedded" % ``` +```scala +libraryDependencies := "dev.zio" %% "zio-redis-embedded" % "0.1.0" +``` Then you can supply `EmbeddedRedis.layer.orDie` as your `RedisConfig` and you're good to go! diff --git a/docs/index.md b/docs/index.md index cdd0d0d..1439507 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,25 +4,20 @@ title: "Introduction to ZIO Redis" sidebar_label: "ZIO Redis" --- -[ZIO Redis](https://github.com/zio/zio-redis) is a ZIO native Redis client. - @PROJECT_BADGES@ ## Introduction -ZIO Redis is in the experimental phase of development, but its goals are: - -- **Type Safety** -- **Performance** -- **Minimum Dependency** -- **ZIO Native** +[ZIO Redis](https://github.com/zio/zio-redis) is a ZIO-native Redis client. +It aims to provide a **type-safe** and **performant** API for accessing Redis +instances. ## Installation -Since the ZIO Redis is in the experimental phase, it is not released yet, but we can use snapshots: +To use ZIO Redis, add the following line to your `build.sbt`: ```scala -libraryDependencies += "dev.zio" %% "zio-redis" % "" +libraryDependencies += "dev.zio" %% "zio-redis" % "@VERSION@" ``` ## Example @@ -37,7 +32,7 @@ To run this example we should put following dependencies in our `build.sbt` file ```scala libraryDependencies ++= Seq( - "dev.zio" %% "zio-redis" % "", + "dev.zio" %% "zio-redis" % "@VERSION@", "dev.zio" %% "zio-schema-protobuf" % "0.3.0" ) ``` @@ -71,7 +66,9 @@ object ZIORedisExample extends ZIOAppDefault { To test you can use the embedded redis instance by adding to your build: -```libraryDependencies := "dev.zio" %% "zio-redis-embedded" % ``` +```scala +libraryDependencies := "dev.zio" %% "zio-redis-embedded" % "@VERSION@" +``` Then you can supply `EmbeddedRedis.layer.orDie` as your `RedisConfig` and you're good to go! -- GitLab