Merge pull request #13 from Kimbbakar/update-readme

update readme
Kimbbakar · Dec 16, 2021 · a26c6c3 · a26c6c3
2 parents 2c279a0 + 5769a2c
commit a26c6c3
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,40 @@
-### YATT
+## YATT
+
+A light weight command line note taking tools.
+
+#### Installation
+```
+go get github.com/Kimbbakar/yatt
+```
+#### Features from v1.0 release
+1. Create note
+    ```
+    yatt create - n "my first note"
+    ``` 
+
+2. List notes
+    ```
+    yatt list [-t]
+
+    # Response
+    ID: 35410507ede64956a48ed4f5a09c10f8
+    Date: Thu, 16 Dec 2021 10:37:45 +06
+
+        Note: my 2nd note
+
+    ID: 98ad7029b0da4862b973d2549d7967ea
+    Date: Thu, 16 Dec 2021 10:37:38 +06
+
+        Note: my first note
+
+    ```
+
+3. Delete Note
+    ```
+    yatt delete <id>
+    ```
+
+4. Flash/Remove all notes
+    ```
+    yatt flash
+    ```
diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/kimbbakar/yatt
+module github.com/Kimbbakar/yatt
 
 go 1.16