update docs

koki-develop · Apr 16, 2023 · e381743 · e381743
1 parent 847e382
commit e381743
Show file tree

Hide file tree

Showing 9 changed files with 100 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ Grow github grass to console.
 
 ## Installation
 
-```console
+```sh
 $ gh extension install koki-develop/gh-grass
 ```
 
@@ -32,28 +32,57 @@ Usage:
 Flags:
   -u, --user string    github username
   -t, --theme string   grass theme (dark|light) (default "dark")
+  -g, --grass string   grass string (default "■")
       --total          print total contributions
   -h, --help           help for gh
 ```
 
 ### Basic
 
-```console
+```sh
 $ gh grass
 ```
 
 ![demo](./docs/demo.gif)
 
 ### Specify a User
 
-You can specify a user with the `-u` or `--user` flag.
-
-```console
+```sh
 $ gh grass --user <USERNAME>
+# e.g.
+$ gh grass --user koki-develop
 ```
 
 ![](./docs/user.gif)
 
+### Change Theme
+
+```sh
+$ gh grass --theme <dark or light>
+# e.g.
+$ gh grass --theme light
+```
+
+![](./docs/theme.gif)
+
+### Print Total Contributions
+
+```sh
+$ gh grass --total
+```
+
+![](./docs/total.gif)
+
+### Custom Grass
+
+```sh
+$ gh grass --grass "<GRASS STRING>"
+# e.g.
+$ gh grass --grass "●"
+```
+
+![](./docs/grass.gif)
+
 ## LICENSE
 
 [MIT](./LICENSE)
diff --git a/docs/demo.gif b/docs/demo.gif
diff --git a/docs/grass.gif b/docs/grass.gif
diff --git a/docs/theme.gif b/docs/theme.gif
diff --git a/docs/total.gif b/docs/total.gif
diff --git a/docs/user.gif b/docs/user.gif
diff --git a/tapes/grass.tape b/tapes/grass.tape
@@ -0,0 +1,22 @@
+Output docs/grass.gif
+
+Require gh
+
+Set Shell "bash"
+Set FontSize 32
+Set Width 2200
+Set Height 600
+Set PlaybackSpeed 0.6
+
+Hide
+Type "go build ." Enter
+Type "gh extension remove grass" Enter
+Type "gh extension install ." Enter
+Type "gh grass --help" Enter
+Ctrl+l
+Sleep 3s
+Show
+
+Type 'gh grass --grass "●"' Sleep 500ms Enter
+
+Sleep 5s
diff --git a/tapes/theme.tape b/tapes/theme.tape
@@ -0,0 +1,22 @@
+Output docs/theme.gif
+
+Require gh
+
+Set Shell "bash"
+Set FontSize 32
+Set Width 2200
+Set Height 600
+Set PlaybackSpeed 0.6
+
+Hide
+Type "go build ." Enter
+Type "gh extension remove grass" Enter
+Type "gh extension install ." Enter
+Type "gh grass --help" Enter
+Ctrl+l
+Sleep 3s
+Show
+
+Type "gh grass --theme light" Sleep 500ms Enter
+
+Sleep 5s
diff --git a/tapes/total.tape b/tapes/total.tape
@@ -0,0 +1,22 @@
+Output docs/total.gif
+
+Require gh
+
+Set Shell "bash"
+Set FontSize 32
+Set Width 2200
+Set Height 600
+Set PlaybackSpeed 0.6
+
+Hide
+Type "go build ." Enter
+Type "gh extension remove grass" Enter
+Type "gh extension install ." Enter
+Type "gh grass --help" Enter
+Ctrl+l
+Sleep 3s
+Show
+
+Type "gh grass --total" Sleep 500ms Enter
+
+Sleep 5s