From cfa7d1004845041be59194df8c8808e564c06ad0 Mon Sep 17 00:00:00 2001
From: Darwin Cereska <157426553+darwincereska@users.noreply.github.com>
Date: Mon, 24 Nov 2025 12:27:05 -0500
Subject: [PATCH] Create README.md

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eda6a94
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# kargs
+All-in-one tool for building cli applications in Kotlin
+
+# Installation
+```kotlin
+/** build.gradle.kts */
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  implementation("org.kargs:kargs:version")
+}
+```
+
+# Usage
+
+## Parser
+```kotlin
+// Main.kt
+import org.kargs.*
+
+fun main(args: Array<String>) {
+  val parser = Parser("program name")
+
+  // Register subcommands
+  parser.subcommands(
+    TestCommand1(),
+    TestCommand2(),
+    ...
+  )
+
+  parser.parse(args)
+```
+
+## Subcommand
+```kotlin
+// Subcommand.kt
+import org.kargs.*
+
+class TestCommand : Subcommand("name", "description", aliases = listOf("alias1", "alias2")) {
+  override fun execute() {
+    println("Logic")
+  }
+}