summaryrefslogtreecommitdiff
path: root/plugins/catimg/README.md
blob: 8f268805072d639298fdd18e461bdae888e60b56 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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)