43e5c9093a303acaac861c723b4de1914adcf99f

Author
Griko Nibras <grikomsn@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

catimg: add README (#7232)

Diff

 1diff --git a/plugins/catimg/README.md b/plugins/catimg/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..2fc28a1c606fcd21423523afec6efb7bfdbf8690
 4--- /dev/null
 5+++ b/plugins/catimg/README.md
 6@@ -0,0 +1,35 @@
 7+# catimg
 8+
 9+Plugin for displaying images on the terminal using the the `catimg.sh` script provided by [posva](https://github.com/posva/catimg)
10+
11+## Requirements
12+
13+- `convert` (ImageMagick)
14+
15+## Enabling the plugin
16+
17+1. Open your `.zshrc` file and add `catimg` in the plugins section:
18+
19+   ```zsh
20+   plugins=(
21+       # all your enabled plugins
22+       catimg
23+   )
24+   ```
25+
26+2. Reload the source file or restart your Terminal session:
27+
28+   ```console
29+   $ source ~/.zshrc
30+   $
31+   ```
32+
33+## Functions
34+
35+| Function | Description                              |
36+| -------- | ---------------------------------------- |
37+| `catimg` | Displays the given image on the terminal |
38+
39+## Usage examples
40+
41+[![asciicast](https://asciinema.org/a/204702.png)](https://asciinema.org/a/204702)