From 5e7f5572c03a61f9ef07da5c7b414abdfbe8828a Mon Sep 17 00:00:00 2001
From: Edric <edric.chan.1997@gmail.com>
Date: Fri, 30 Jun 2023 18:22:50 +0800
Subject: [PATCH] docs(common-enums): initial module docs

---
 androidx/common/common-enums/Module.md | 107 +++++++++++++++++++++++++
 1 file changed, 107 insertions(+)
 create mode 100644 androidx/common/common-enums/Module.md

diff --git a/androidx/common/common-enums/Module.md b/androidx/common/common-enums/Module.md
new file mode 100644
index 0000000..0146a45
--- /dev/null
+++ b/androidx/common/common-enums/Module.md
@@ -0,0 +1,107 @@
+# Module common-enums
+
+Common enums utilities for androidx-ktx-extras' modules.
+
+## Usage
+
+<a href="https://central.sonatype.com/artifact/io.github.edricchan03.androidx.common/common-enums"><img src="https://flat.badgen.net/maven/v/maven-central/io.github.edricchan03.androidx.common/common-enums" alt="Common Enums on Maven Central"></a>
+
+Common Enums is available on [Maven Central](https://central.sonatype.com) as the Maven coordinate [`io.github.edricchan03.androidx.common:common-enums`](https://central.sonatype.com/artifact/io.github.edricchan03.androidx.common/common-enums):
+
+`settings.gradle.kts`
+
+```kotlin
+dependencyResolutionManagement {
+  // ...
+  repositories {
+    mavenCentral()
+  }
+}
+```
+
+### Kotlin/Groovy
+
+`build.gradle.kts`
+
+```kotlin
+implementation("io.github.edricchan03.androidx.common:common-enums:0.0.1")
+```
+
+### TOML
+
+`gradle/libs.versions.toml`:
+
+```toml
+[libraries]
+androidxtra-common-enums = "io.github.edricchan03.androidx.common:common-enums:0.0.1"
+```
+
+`build.gradle.kts`:
+
+```kotlin
+implementation(libs.androidxtra.common.enums)
+```
+
+### Snapshots
+
+Alternatively, you can grab the latest built snapshot from Maven Central's snapshots
+repository:
+
+`settings.gradle.kts`
+
+```kotlin
+dependencyResolutionManagement {
+  // ...
+  repositories {
+    maven("https://s01.oss.sonatype.org/content/repositories/snapshots/") {
+      // Optionally, you can specify that only snapshots are to be used
+      mavenContent {
+        snapshotsOnly()
+      }
+    }
+  }
+}
+```
+
+#### Kotlin
+
+`build.gradle.kts`:
+
+```kotlin
+implementation("io.github.edricchan03.androidx.common:common-enums:0.0.1-SNAPSHOT")
+```
+
+#### TOML
+
+`gradle/libs.versions.toml`:
+
+```toml
+[libaries]
+androidxtra-common-enums = "io.github.edricchan03.androidx.common:common-enums:0.0.1-SNAPSHOT"
+```
+
+`build.gradle.kts`:
+
+```kotlin
+implementation(libs.androidxtra.common.enums)
+```
+
+# Package io.github.edricchan03.androidx.common.enums
+
+Common enum utilities such as [`EnumFromValue`][io.github.edricchan03.androidx.common.enums.EnumFromValue]:
+
+```kotlin
+enum class Example(val value: String) {
+    One("one"),
+    Two("two"),
+    Three("abc");
+
+    companion object : EnumFromValue<String, Example>(default = Three) {
+        override fun fromValueOrNull(value: String) = when (value) {
+            "one" -> One
+            "two" -> Two
+            "abc", "other value" -> Three
+            else -> null
+  }
+}
+```