47004414a0a73ecd33c2a1d4b17dd4f79222ba08
- Author
- Griko Nibras <grikomsn@gmail.com>
- Committer
- Marc Cornellà <marc.cornella@live.com>
- Date
Message
encode64: add README (#7192)
Diff
1diff --git a/plugins/encode64/README.md b/plugins/encode64/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..9850da85f3fae60688c039c5371fdd8bfbf3902f
4--- /dev/null
5+++ b/plugins/encode64/README.md
6@@ -0,0 +1,69 @@
7+# encode64
8+
9+Alias plugin for encoding or decoding using `base64` command
10+
11+## Functions and Aliases
12+
13+| Function | Alias | Description |
14+| ---------- | ----- | ------------------------------ |
15+| `encode64` | `e64` | Encodes given data to base64 |
16+| `decode64` | `d64` | Decodes given data from base64 |
17+
18+## Enabling plugin
19+
20+1. Edit your `.zshrc` file and add `encode64` to the list of plugins:
21+
22+ ```sh
23+ plugins=(
24+ # ...other enabled plugins
25+ encode64
26+ )
27+ ```
28+
29+2. Restart your terminal session or reload configuration by running:
30+
31+ ```sh
32+ source ~/.zshrc
33+ ```
34+
35+## Usage and examples
36+
37+### Encoding
38+
39+- From parameter
40+
41+ ```console
42+ $ encode64 "oh-my-zsh"
43+ b2gtbXktenNo
44+ $ e64 "oh-my-zsh"
45+ b2gtbXktenNo
46+ ```
47+
48+- From piping
49+
50+ ```console
51+ $ echo "oh-my-zsh" | encode64
52+ b2gtbXktenNo==
53+ $ echo "oh-my-zsh" | e64
54+ b2gtbXktenNo==
55+ ```
56+
57+### Decoding
58+
59+- From parameter
60+
61+ ```console
62+ $ decode64 b2gtbXktenNo
63+ oh-my-zsh%
64+ $ d64 b2gtbXktenNo
65+ oh-my-zsh%
66+ ```
67+
68+- From piping
69+
70+ ```console
71+ $ echo "b2gtbXktenNoCg==" | decode64
72+ oh-my-zsh
73+ $ echo "b2gtbXktenNoCg==" | decode64
74+ oh-my-zsh
75+ ```