summaryrefslogtreecommitdiff
path: root/plugins/catimg/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2020-04-24 20:54:33 -0600
committerTuowen Zhao <ztuowen@gmail.com>2020-04-24 20:54:33 -0600
commitc197ad40f1dca62fd1e0e555e7bfc84e39f31223 (patch)
tree5c1e753e0ff2cb9d0e08a699f17352225b9ef9f1 /plugins/catimg/README.md
parent0b67340fd2fe9330d8487491e1983ad1a111fb2b (diff)
parent2560f04982dfc2693221c7c0f47d1a71df09a794 (diff)
downloadzsh-c197ad40f1dca62fd1e0e555e7bfc84e39f31223.tar.gz
zsh-c197ad40f1dca62fd1e0e555e7bfc84e39f31223.tar.bz2
zsh-c197ad40f1dca62fd1e0e555e7bfc84e39f31223.zip
Merge branch 'master' of https://github.com/ohmyzsh/ohmyzsh
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