Merge pull request #36 from momentohq/add-readme

feat: set up readme generation

.github/workflows/ci.yml

@@ -25,14 +25,14 @@ jobs:
     - name: Setup Android SDK
       uses: android-actions/setup-android@v3
 
-#    - name: Verify README generation
-#      uses: momentohq/standards-and-practices/github-actions/oss-readme-template@gh-actions-v2
-#      with:
-#        project_status: official
-#        project_stability: stable
-#        project_type: sdk
-#        sdk_language: Java
-#        dev_docs_slug: java
+    - name: Verify README generation
+      uses: momentohq/standards-and-practices/github-actions/oss-readme-template@gh-actions-v2
+      with:
+        project_status: incubating
+        project_stability: alpha
+        project_type: sdk
+        sdk_language: Kotlin
+        dev_docs_slug: kotlin
 
     - name: Commitlint and Other Shared Build Steps
       uses: momentohq/standards-and-practices/github-actions/shared-build@gh-actions-v1

.github/workflows/on-push-to-main-branch.yml

@@ -0,0 +1,21 @@
+name: On push to main branch
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup repo
+        uses: actions/checkout@v4
+
+      - name: Generate README
+        uses: momentohq/standards-and-practices/github-actions/generate-and-commit-oss-readme@gh-actions-v2
+        with:
+          project_status: incubating
+          project_stability: alpha
+          project_type: sdk
+          sdk_language: Kotlin
+          dev_docs_slug: kotlin

README.md → CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Momento Kotlin SDK
+# Development
 
 Requires the android sdk installed and the ANDROID_HOME environment variable set:
 ```bash

README.template.md

@@ -0,0 +1,51 @@
+{{ ossHeader }}
+
+## 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
+<repository>
+    <id>sonatype-snapshots</id>
+    <name>Sonatype Snapshots</name>
+    <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
+</repository>
+
+<dependency>
+    <groupId>software.momento.kotlin</groupId>
+    <artifactId>sdk</artifactId>
+    <version>0.1.0-SNAPSHOT</version>
+</dependency>
+```
+
+## Usage
+
+Examples coming soon.
+
+## Getting Started and Documentation
+
+Documentation coming soon on the [Momento Docs website](https://docs.momentohq.com).
+
+## Examples
+
+Examples coming soon.
+
+## Developing
+
+If you are interested in contributing to the SDK, please see the [CONTRIBUTING](./CONTRIBUTING.md) docs.
+
+{{ ossFooter }}