diff options
Diffstat (limited to 'home/.oh-my-zsh/plugins/catimg/README.md')
| -rw-r--r-- | home/.oh-my-zsh/plugins/catimg/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/catimg/README.md b/home/.oh-my-zsh/plugins/catimg/README.md new file mode 100644 index 0000000..4cfda0e --- /dev/null +++ b/home/.oh-my-zsh/plugins/catimg/README.md @@ -0,0 +1,24 @@ +# catimg + +Plugin for displaying images on the terminal using 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 + +- `magick convert` (ImageMagick) + +## Functions + +| Function | Description | +| -------- | ---------------------------------------- | +| `catimg` | Displays the given image on the terminal | + +## Usage examples + +[](https://asciinema.org/a/204702) |