From efa0d11b2ecddf381a7b1c1d684ecf5ec99bdddd Mon Sep 17 00:00:00 2001
From: MURAOKA Taro <koron.kaoriya@gmail.com>
Date: Thu, 14 Mar 2024 23:24:21 +0900
Subject: [PATCH] doc

---
 README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)

diff --git a/README.md b/README.md
index a7649ef..c19bc70 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,93 @@ Install or update:
 ```console
 $ go install github.com/koron-go/subcmd@latest
 ```
+
+The basic usage consists of just 3 steps.
+
+1. Define commands with function.
+
+    ```go
+    package item
+
+    import "github.com/koron-go/subcmd"
+
+    var List = subcmd.DefineCommand("list", "list items", func(ctx context.Context, args []string) error {
+        // TODO: list your items (A)
+        return nil
+    })
+
+    var Add = subcmd.DefineCommand("add", "add a new item", func(ctx context.Context, args []string) error {
+        // TODO: add a your item (B)
+        return nil
+    })
+    ```
+
+2. Define command sets by bundling the defined commands.
+
+    ```go
+    package item
+
+    var CommandSet = subcmd.DefineSet("item", List, Add)
+    ```
+
+    Similarly, assume that multiple commands (List/Add/Delete) have been defined for user package.
+
+    ```go
+    package user
+
+    var CommandSet = subcmd.DefineSet("user", List, Add, Delete)
+    ```
+
+3. Call function `subcmd.Run()` with the defined set from `main()`.
+
+    ```go
+    package main
+
+    import (
+        "log"
+        "os"
+
+        "github.com/koron-go/subcmd"
+
+        "{some/pacakge/path}/item"
+        "{some/package/path}/user"
+    )
+
+    var rootSet = subcmd.DefineRootSet(
+        item.CommandSet,
+        user.CommandSet,
+    )
+
+    func main() {
+        if err := subcmd.Run(rootSet, os.Args[1:]...); err != nil {
+            log.Fatal(err)
+        }
+    }
+    ```
+
+This will enable you to use subcommands such as the following:
+
+```console
+# This call (A)
+$ myprog item list
+
+# This call (B)
+$ myprog item add
+
+# List subcommands in "item" command set
+$ myprog item --list
+
+# Same about "user" command set.
+$ myprog user list
+$ myprog user add
+$ myprog user delete
+$ myprog user --help
+```
+
+## Concept
+
+* Want to write each command as a function.
+* Want to associate command name and description with a function.
+* Want to make commands and command sets reusable, and re-assemblable.
+* Don't want to use types that are not in the standard library in the function signature.
+* Don't want to declare a `struct` or define a type instead of a function.