summaryrefslogtreecommitdiff
path: root/plugins/encode64
diff options
context:
space:
mode:
authorKozlov Alexander <badryke@gmail.com>2018-11-16 13:38:43 +0300
committerGitHub <noreply@github.com>2018-11-16 13:38:43 +0300
commit8c95c52353118643ac3dbd9b0c185a3129b84bf8 (patch)
treeee7497251b7a541480ae5c6a97b63b14381ed5ee /plugins/encode64
parentdd30cf104c9ca42d89d26a134382ca421869ce7e (diff)
parent3d8f2bda599c8c6d160dc448e5ab28aaf2d5e90d (diff)
downloadzsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.gz
zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.bz2
zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.zip
Merge branch 'master' into master
Diffstat (limited to 'plugins/encode64')
-rw-r--r--plugins/encode64/README.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/plugins/encode64/README.md b/plugins/encode64/README.md
new file mode 100644
index 000000000..9850da85f
--- /dev/null
+++ b/plugins/encode64/README.md
@@ -0,0 +1,69 @@
+# encode64
+
+Alias plugin for encoding or decoding using `base64` command
+
+## Functions and Aliases
+
+| Function | Alias | Description |
+| ---------- | ----- | ------------------------------ |
+| `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
+
+- From parameter
+
+ ```console
+ $ encode64 "oh-my-zsh"
+ b2gtbXktenNo
+ $ e64 "oh-my-zsh"
+ b2gtbXktenNo
+ ```
+
+- From piping
+
+ ```console
+ $ echo "oh-my-zsh" | encode64
+ b2gtbXktenNo==
+ $ echo "oh-my-zsh" | e64
+ b2gtbXktenNo==
+ ```
+
+### Decoding
+
+- From parameter
+
+ ```console
+ $ decode64 b2gtbXktenNo
+ oh-my-zsh%
+ $ d64 b2gtbXktenNo
+ oh-my-zsh%
+ ```
+
+- From piping
+
+ ```console
+ $ echo "b2gtbXktenNoCg==" | decode64
+ oh-my-zsh
+ $ echo "b2gtbXktenNoCg==" | decode64
+ oh-my-zsh
+ ```