update

orangekame3 · Oct 8, 2023 · 9d36555 · 9d36555
1 parent 62159f5
commit 9d36555
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 <div align="center">
 
-# :octocat: ghfetch
-  
-ghfetch is a clear command with PAC-MAN animation
+# ghfetch
+
+:octocat: ghfetch is a CLI tool to fetch GitHub user information.
 
 <a href="https://opensource.org/licenses/MIT">
 <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="MIT License badge">
@@ -34,3 +34,24 @@ go install github.com/orangekame3/ghfetch@latest
 ```shell
 brew install orangekame3/tap/ghfetch
 ```
+
+## Usage
+
+```shell
+❯ ghfetch -h
+Fetch GitHub user's profile
+
+Usage:
+  ghfetch [flags]
+
+Flags:
+  -c, --color string   Highlight color for text (default "blue")
+  -h, --help           help for ghfetch
+  -t, --toggle         Help message for toggle
+  -u, --user string    GitHub username
+  -v, --version        version for ghfetch
+```
+
+## To Do
+
+- [ ] Add GitHub stats
diff --git a/img/demo.gif b/img/demo.gif
diff --git a/img/demo.tape b/img/demo.tape
@@ -44,7 +44,7 @@ Output img/demo.gif
 
 Set FontSize 32
 Set Width 2000
-Set Height 1000
+Set Height 1200
 
 Sleep 500ms
 Type "ghfetch -u orangekame3" Sleep 1000ms Enter