summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEltrac <hi@guhub.cn>2025-11-10 13:18:11 +0800
committerEltrac <hi@guhub.cn>2025-11-10 13:18:11 +0800
commitc00491fbf097c0ec662e28a8938aa96ea7e02c45 (patch)
tree6afa0bfa8c0b20fb0a0f7747a86a5cd18a5928a7
parent13032b771a214db2228c96e7f82f4709b9a35270 (diff)
docs: update README
-rw-r--r--README.md14
-rw-r--r--demo.gifbin0 -> 4218211 bytes
2 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4db763e..66ab231 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,19 @@
-> [!warning] Warning
+> [!warning]
> This project is still a work-in-progress. There may be bugs and missing features.
+![](demo.gif)
+
# wthis
-A CLI tool to fetch information about a Homebrew formulae or cask.
+A CLI tool to fetch information about a Homebrew formulae or cask. `wthis` stands for "What the heck is ...?"
+
+## Installation
+
+```shell
+brew install eltrac/wthis/wthis
+```
+
+## Usage
```shell
wthis <package-name>
diff --git a/demo.gif b/demo.gif
new file mode 100644
index 0000000..ac33fa4
--- /dev/null
+++ b/demo.gif
Binary files differ