summaryrefslogtreecommitdiff
path: root/plugins/catimg/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/catimg/README.md')
-rw-r--r--plugins/catimg/README.md24
1 files changed, 6 insertions, 18 deletions
diff --git a/plugins/catimg/README.md b/plugins/catimg/README.md
index 42b59a62c..8f2688050 100644
--- a/plugins/catimg/README.md
+++ b/plugins/catimg/README.md
@@ -2,27 +2,15 @@
Plugin for displaying images on the terminal using the the `catimg.sh` script provided by [posva](https://github.com/posva/catimg)
-## Requirements
-
-- `convert` (ImageMagick)
-
-## Enabling the plugin
+To use it, add `catimg` to the plugins array in your zshrc file:
-1. Open your `.zshrc` file and add `catimg` in the plugins section:
+```zsh
+plugins=(... catimg)
+```
- ```zsh
- plugins=(
- # all your enabled plugins
- catimg
- )
- ```
-
-2. Restart the shell or restart your Terminal session:
+## Requirements
- ```console
- $ exec zsh
- $
- ```
+- `convert` (ImageMagick)
## Functions