]> src.twobees.de Git - dotfiles.git/blob - stow/oh-my-zsh/.oh-my-zsh/plugins/catimg/README.md
initial
[dotfiles.git] / stow / oh-my-zsh / .oh-my-zsh / plugins / catimg / README.md
1 # catimg
2
3 Plugin for displaying images on the terminal using the the `catimg.sh` script provided by [posva](https://github.com/posva/catimg)
4
5 To use it, add `catimg` to the plugins array in your zshrc file:
6
7 ```zsh
8 plugins=(... catimg)
9 ```
10
11 ## Requirements
12
13 - `convert` (ImageMagick)
14
15 ## Functions
16
17 | Function | Description                              |
18 | -------- | ---------------------------------------- |
19 | `catimg` | Displays the given image on the terminal |
20
21 ## Usage examples
22
23 [![asciicast](https://asciinema.org/a/204702.png)](https://asciinema.org/a/204702)