summaryrefslogtreecommitdiff
path: root/plugins/catimg
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/catimg')
-rw-r--r--plugins/catimg/README.md35
-rw-r--r--plugins/catimg/catimg.plugin.zsh2
-rw-r--r--[-rwxr-xr-x]plugins/catimg/catimg.sh2
3 files changed, 37 insertions, 2 deletions
diff --git a/plugins/catimg/README.md b/plugins/catimg/README.md
new file mode 100644
index 000000000..2fc28a1c6
--- /dev/null
+++ b/plugins/catimg/README.md
@@ -0,0 +1,35 @@
+# catimg
+
+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
+
+1. Open your `.zshrc` file and add `catimg` in the plugins section:
+
+ ```zsh
+ plugins=(
+ # all your enabled plugins
+ catimg
+ )
+ ```
+
+2. Reload the source file or restart your Terminal session:
+
+ ```console
+ $ source ~/.zshrc
+ $
+ ```
+
+## 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)
diff --git a/plugins/catimg/catimg.plugin.zsh b/plugins/catimg/catimg.plugin.zsh
index cb92f5986..5f58ecde3 100644
--- a/plugins/catimg/catimg.plugin.zsh
+++ b/plugins/catimg/catimg.plugin.zsh
@@ -1,6 +1,6 @@
################################################################################
# catimg script by Eduardo San Martin Morote aka Posva #
-# http://posva.net #
+# https://posva.net #
# #
# Ouput the content of an image to the stdout using the 256 colors of the #
# terminal. #
diff --git a/plugins/catimg/catimg.sh b/plugins/catimg/catimg.sh
index cd0f2e333..83ccf6a95 100755..100644
--- a/plugins/catimg/catimg.sh
+++ b/plugins/catimg/catimg.sh
@@ -1,6 +1,6 @@
################################################################################
# catimg script by Eduardo San Martin Morote aka Posva #
-# http://posva.net #
+# https://posva.net #
# #
# Ouput the content of an image to the stdout using the 256 colors of the #
# terminal. #