diff options
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/catimg/README.md')
| -rw-r--r-- | .config/zsh/oh-my-zsh/plugins/catimg/README.md | 23 |
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 + +[](https://asciinema.org/a/204702) |