README.md 570 Bytes
Newer Older
Griko Nibras's avatar
Griko Nibras committed
1
2
3
4
# catimg

Plugin for displaying images on the terminal using the the `catimg.sh` script provided by [posva](https://github.com/posva/catimg)

5
To use it, add `catimg` to the plugins array in your zshrc file:
Griko Nibras's avatar
Griko Nibras committed
6

7
8
9
```zsh
plugins=(... catimg)
```
Griko Nibras's avatar
Griko Nibras committed
10

11
## Requirements
Griko Nibras's avatar
Griko Nibras committed
12

13
- `convert` (ImageMagick)
Griko Nibras's avatar
Griko Nibras committed
14
15
16
17
18
19
20
21
22
23

## 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)