From da18a692d60755bc81e7f607755488045aabfc7c Mon Sep 17 00:00:00 2001 From: Michael Landis Date: Tue, 17 Sep 2024 10:24:05 -0700 Subject: [PATCH 1/2] chore: update readme with doc examples Now that the doc examples have been submitted, we update the README template to inline them. --- README.template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.template.md b/README.template.md index 1a2cab8..0c6ea8d 100644 --- a/README.template.md +++ b/README.template.md @@ -25,11 +25,13 @@ The Momento Lettuce compatibility client is [available on Maven Central](https:/ To switch your existing `lettuce` application to use Momento Cache, you only need to change the code where you construct your client object. Here is an example of constructing a Momento lettuce client: ```java +{% include "./examples/src/main/java/momento/lettuce/example/doc_examples/ReadmeExample.java" %} ``` Additionally, to understand what APIs are supported, you can use the interface `MomentoRedisReactiveCommands` which contains only those APIs that are supported by this compatibility client: ```java +{% include "./examples/src/main/java/momento/lettuce/example/doc_examples/LimitedApiExample.java" %} ``` ## Current Redis API support From 8564c944e0a8d916caf6a0912b917c8cb9852a1e Mon Sep 17 00:00:00 2001 From: Michael Landis Date: Tue, 17 Sep 2024 10:29:22 -0700 Subject: [PATCH 2/2] docs: clarify dependencies to install --- README.template.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.template.md b/README.template.md index 0c6ea8d..4ec6da2 100644 --- a/README.template.md +++ b/README.template.md @@ -10,6 +10,8 @@ use the same code with either a Redis server or with the Momento Cache service! ## Installation +To use the compatiblity client, you will need three dependencies in your project: the Momento Lettuce compatibility client, the Momento Cache client, and the lettuce client. + The Momento Lettuce compatibility client is [available on Maven Central](https://search.maven.org/artifact/software.momento.java/momento-lettuce). You can add it to your project via: ```xml @@ -20,6 +22,18 @@ The Momento Lettuce compatibility client is [available on Maven Central](https:/ ``` +You will also need to add the Momento Cache client library to your project. You can find the latest version of the Momento Cache client library [on Maven Central](https://central.sonatype.com/artifact/software.momento.java/sdk) as well: + +```xml + + software.momento.java + sdk + 1.15.0 + +``` + +As well as the lettuce client also [on Maven Central](https://central.sonatype.com/artifact/io.lettuce/lettuce-core). + ## Usage To switch your existing `lettuce` application to use Momento Cache, you only need to change the code where you construct your client object. Here is an example of constructing a Momento lettuce client: