summaryrefslogtreecommitdiff
path: root/plugins/encode64
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/encode64')
-rw-r--r--plugins/encode64/README.md27
1 files changed, 8 insertions, 19 deletions
diff --git a/plugins/encode64/README.md b/plugins/encode64/README.md
index 9850da85f..86320cffb 100644
--- a/plugins/encode64/README.md
+++ b/plugins/encode64/README.md
@@ -1,6 +1,12 @@
# encode64
-Alias plugin for encoding or decoding using `base64` command
+Alias plugin for encoding or decoding using `base64` command.
+
+To use it, add `encode64` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... encode64)
+```
## Functions and Aliases
@@ -9,23 +15,6 @@ Alias plugin for encoding or decoding using `base64` command
| `encode64` | `e64` | Encodes given data to base64 |
| `decode64` | `d64` | Decodes given data from base64 |
-## Enabling plugin
-
-1. Edit your `.zshrc` file and add `encode64` to the list of plugins:
-
- ```sh
- plugins=(
- # ...other enabled plugins
- encode64
- )
- ```
-
-2. Restart your terminal session or reload configuration by running:
-
- ```sh
- source ~/.zshrc
- ```
-
## Usage and examples
### Encoding
@@ -64,6 +53,6 @@ Alias plugin for encoding or decoding using `base64` command
```console
$ echo "b2gtbXktenNoCg==" | decode64
oh-my-zsh
- $ echo "b2gtbXktenNoCg==" | decode64
+ $ echo "b2gtbXktenNoCg==" | d64
oh-my-zsh
```