diff --git a/README.md b/README.md new file mode 100644 index 0000000..66ed47f --- /dev/null +++ b/README.md @@ -0,0 +1,107 @@ +
+ + + + +[![project status](https://momentohq.github.io/standards-and-practices/badges/project-status-incubating.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-alpha.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md) + +# Momento Kotlin Client Library + +:warning: Experimental SDK :warning: + +This is an incubating project; it may or may not achieve official supported status, and the APIs are subject to +backward incompatible changes. For more info, click on the incubating badge above. + + +Momento Cache is a fast, simple, pay-as-you-go caching solution without any of the operational overhead +required by traditional caching solutions. This repo contains the source code for the Momento Kotlin client library. + +To get started with Momento you will need a Momento Auth Token. You can get one from the [Momento Console](https://console.gomomento.com). + +* Website: [https://www.gomomento.com/](https://www.gomomento.com/) +* Momento Documentation: [https://docs.momentohq.com/](https://docs.momentohq.com/) +* Getting Started: [https://docs.momentohq.com/getting-started](https://docs.momentohq.com/getting-started) +* Kotlin SDK Documentation: [https://docs.momentohq.com/develop/sdks/kotlin](https://docs.momentohq.com/develop/sdks/kotlin) +* Discuss: [Momento Discord](https://discord.gg/3HkAKjUZGq) + +## Packages + +The Kotlin SDK is available on the Sonatype Central snapshots repo: + +### Gradle + +```kotlin +repositories { + maven("https://s01.oss.sonatype.org/content/repositories/snapshots/") +} + +dependencies { + implementation("software.momento.kotlin:sdk:0.1.0-SNAPSHOT") +} +``` + +### Maven + +```xml +