summaryrefslogtreecommitdiff
path: root/plugins/catimg
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/catimg')
-rw-r--r--plugins/catimg/README.md24
-rw-r--r--plugins/catimg/catimg.plugin.zsh2
-rw-r--r--plugins/catimg/catimg.sh2
3 files changed, 8 insertions, 20 deletions
diff --git a/plugins/catimg/README.md b/plugins/catimg/README.md
index 2fc28a1c6..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. Reload the source file or restart your Terminal session:
+## Requirements
- ```console
- $ source ~/.zshrc
- $
- ```
+- `convert` (ImageMagick)
## Functions
diff --git a/plugins/catimg/catimg.plugin.zsh b/plugins/catimg/catimg.plugin.zsh
index 5f58ecde3..ca46444cc 100644
--- a/plugins/catimg/catimg.plugin.zsh
+++ b/plugins/catimg/catimg.plugin.zsh
@@ -4,7 +4,7 @@
# #
# Ouput the content of an image to the stdout using the 256 colors of the #
# terminal. #
-# Github: https://github.com/posva/catimg #
+# GitHub: https://github.com/posva/catimg #
################################################################################
diff --git a/plugins/catimg/catimg.sh b/plugins/catimg/catimg.sh
index 83ccf6a95..713a03291 100644
--- a/plugins/catimg/catimg.sh
+++ b/plugins/catimg/catimg.sh
@@ -4,7 +4,7 @@
# #
# Ouput the content of an image to the stdout using the 256 colors of the #
# terminal. #
-# Github: https://github.com/posva/catimg #
+# GitHub: https://github.com/posva/catimg #
################################################################################
function help() {