summaryrefslogtreecommitdiffstats
path: root/.config/zsh/oh-my-zsh/plugins/catimg/README.md
diff options
context:
space:
mode:
authorLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2025-02-13 14:13:49 +0530
committerLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2025-02-13 14:13:49 +0530
commit8a2e1006b3b272126332aa064f3ad95387129544 (patch)
tree944c80ac612a65980d94a54ba11b6c7102037ecf /.config/zsh/oh-my-zsh/plugins/catimg/README.md
parentdcbb16d8b08ff5956abef5e6478b59df2e93ad35 (diff)
downloaddotfiles-master.tar.gz
dotfiles-master.tar.bz2
dotfiles-master.zip
new dot filesHEADmaster
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/catimg/README.md')
-rw-r--r--.config/zsh/oh-my-zsh/plugins/catimg/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/.config/zsh/oh-my-zsh/plugins/catimg/README.md b/.config/zsh/oh-my-zsh/plugins/catimg/README.md
new file mode 100644
index 0000000..8f26880
--- /dev/null
+++ b/.config/zsh/oh-my-zsh/plugins/catimg/README.md
@@ -0,0 +1,23 @@
+# catimg
+
+Plugin for displaying images on the terminal using the the `catimg.sh` script provided by [posva](https://github.com/posva/catimg)
+
+To use it, add `catimg` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... catimg)
+```
+
+## Requirements
+
+- `convert` (ImageMagick)
+
+## Functions
+
+| Function | Description |
+| -------- | ---------------------------------------- |
+| `catimg` | Displays the given image on the terminal |
+
+## Usage examples
+
+[![asciicast](https://asciinema.org/a/204702.png)](https://asciinema.org/a/204702)