diff --git a/README.md b/README.md index 60334b87..42606f0b 100644 --- a/README.md +++ b/README.md @@ -83,36 +83,30 @@ ## cacheable -A cache like Spring `@Cacheable` and `@cacheEvict` based on zio. It has no implementation of storage media. +A cache like Spring `@Cacheable` and `@cacheEvict` based on zio. It has no implementation of storage media. (not support Scala2.11.x) - `@cacheable` / `Cache.apply` - `@cacheEvict` / `Cache.evict` ```scala -// cache API, include dependencies: zio, zio-streams, zio-logging -"org.bitlap" %% "smt-cacheable" % "" // not support Scala2.11.x +"org.bitlap" %% "smt-cacheable" % "" ``` ## cacheable-redis -A distributed cache based on zio and zio-redis. It needs `cacheable` module. +A distributed cache based on zio and zio-redis. It depends on `cacheable` module. -> TODO Not unavailable, no distributed lock +> TODO Not unavailable ```scala -// distributed cache, include dependencies: zio-redis, config, zio-schema, zio-schema-json, optional (zio-schema-derivation for case class) -// dependsOn `smt-cacheable` "org.bitlap" %% "smt-cacheable-redis" % "" // not support Scala2.11.x ``` ## cacheable-caffeine -A memory cache based on zio and caffeine. It needs `cacheable` module. - +A memory cache based on zio and caffeine. It needs `cacheable` module. (not support Scala2.11.x) ```scala -// local cache, include dependencies: config, caffeine -// dependsOn `smt-cacheable` -"org.bitlap" %% "smt-cacheable-caffeine" % "" // not support Scala2.11.x +"org.bitlap" %% "smt-cacheable-caffeine" % "" ``` The artefacts have been uploaded to Maven Central. Importing the library into your build system (e.g gradle, sbt), is not enough. You need to follow an extra step. @@ -140,7 +134,7 @@ you must still enable the compiler flag `-Ymacro-annotations`. This project is developed using JetBrains IDEA. Thanks to JetBrains for providing me with a free license, which is a strong support for me. -[Stage]: https://img.shields.io/badge/Project%20Stage-Experimental-yellow.svg +[Stage]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg [Badge-CI]: https://github.com/bitlap/smt/actions/workflows/ScalaCI.yml/badge.svg [Badge-Scaladex]: https://index.scala-lang.org/bitlap/smt/smt-annotations/latest.svg?platform=jvm [Badge-Jetbrains]: https://img.shields.io/jetbrains/plugin/v/17202-scala-macro-tools diff --git a/README_CN.md b/README_CN.md index c9fcb044..f3c1f9c6 100644 --- a/README_CN.md +++ b/README_CN.md @@ -101,22 +101,18 @@ 基于zio和zio-redis的分布式缓存实现,内部依赖`cacheable`。 -> TODO,目前不可用,无分布式锁 +> TODO,目前不可用 ```scala -// 分布式缓存, 内部包含的依赖: zio-redis, config, zio-schema, zio-schema-json, 可选的 (zio-schema-derivation用于样例类序列化) -// 依赖于`smt-cacheable` "org.bitlap" %% "smt-cacheable-redis" % "" // 不支持Scala2.11.x ``` ## cacheable-caffeine -基于zio和caffeine的内存缓存实现,内部依赖`cacheable`。 +基于zio和caffeine的内存缓存实现,内部依赖`cacheable`。(不支持Scala2.11.x) ```scala -// 本地缓存, 内部包含的依赖: config, caffeine -// 依赖于`smt-cacheable` -"org.bitlap" %% "smt-cacheable-caffeine" % "" // 不支持Scala2.11.x +"org.bitlap" %% "smt-cacheable-caffeine" % "" ``` 该库已发布到maven中央仓库,请使用最新版本。仅将本库导入构建系统(例如gradle、sbt)是不够的。你需要多走一步。 @@ -142,7 +138,7 @@ addCompilerPlugin("org.scalamacros" % "paradise_" % "