From 894253a70f1e899f3a65e6d4cf781d07a2e3b56f Mon Sep 17 00:00:00 2001 From: cprice404 Date: Thu, 11 Jul 2024 16:38:25 +0000 Subject: [PATCH] Update templated README.md file --- examples/storage/README.md | 39 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 examples/storage/README.md diff --git a/examples/storage/README.md b/examples/storage/README.md new file mode 100644 index 00000000..2c40f102 --- /dev/null +++ b/examples/storage/README.md @@ -0,0 +1,39 @@ +logo + +[![project status](https://momentohq.github.io/standards-and-practices/badges/project-status-official.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md) +[![project stability](https://momentohq.github.io/standards-and-practices/badges/project-stability-beta.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md) + + +# Momento Java SDK - Storage Client Examples + +## Running the Examples + +- You do not need gradle to be installed +- JDK 14 or above is required to run the example +- To get started with Momento you will need a Momento API key. You can get one from the + [Momento Console](https://console.gomomento.com). + +### Basic + +```bash +MOMENTO_API_KEY= ./gradlew basic +``` + +Example Code: [BasicExample.java](src/main/java/momento/client/example/BasicExample.java) + +## Using the Java SDK in your project + +### Gradle Configuration + +Update your Gradle build to include the components + +#### build.gradle.kts + +```kotlin +dependencies { + implementation("software.momento.java:sdk:1.x.x") +} +``` + +---------------------------------------------------------------------------------------- +For more info, visit our website at [https://gomomento.com](https://gomomento.com)!