summaryrefslogtreecommitdiff
path: root/plugins/urltools
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2018-10-09 14:46:47 -0400
committerTuowen Zhao <ztuowen@gmail.com>2018-10-09 14:46:47 -0400
commit075160b86c64045e661209ad7906559068b44104 (patch)
treea910a6eef6163d39859395bb0b416b2b184db9ac /plugins/urltools
parent5ece6ef2f07c58672a9c965dbbbb62a42386fb2d (diff)
parent3c9942c4884089b290ef750468b29419ca0de271 (diff)
downloadzsh-075160b86c64045e661209ad7906559068b44104.tar.gz
zsh-075160b86c64045e661209ad7906559068b44104.tar.bz2
zsh-075160b86c64045e661209ad7906559068b44104.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/urltools')
-rw-r--r--plugins/urltools/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/plugins/urltools/README.md b/plugins/urltools/README.md
new file mode 100644
index 000000000..548301c72
--- /dev/null
+++ b/plugins/urltools/README.md
@@ -0,0 +1,29 @@
+# URLTools plugin
+
+This plugin provides two aliases to URL-encode and URL-decode strings.
+
+To start using it, add the `urltools` plugin to your plugins array in `~/.zshrc`:
+
+```zsh
+plugins=(... urltools)
+```
+
+Original author: [Ian Chesal](https://github.com/ianchesal)
+Original idea and aliases: [Ruslan Spivak](https://ruslanspivak.wordpress.com/2010/06/02/urlencode-and-urldecode-from-a-command-line/)
+
+## Commands
+
+| Command | Description |
+| :---------- | :--------------------------- |
+| `urlencode` | URL-encodes the given string |
+| `urldecode` | URL-decodes the given string |
+
+## Examples
+
+```zsh
+urlencode 'https://github.com/robbyrussell/oh-my-zsh/search?q=urltools&type=Code'
+# returns https%3A%2F%2Fgithub.com%2Frobbyrussell%2Foh-my-zsh%2Fsearch%3Fq%3Durltools%26type%3DCode
+
+urldecode 'https%3A%2F%2Fgithub.com%2Frobbyrussell%2Foh-my-zsh%2Fsearch%3Fq%3Durltools%26type%3DCode'
+# returns https://github.com/robbyrussell/oh-my-zsh/search?q=urltools&type=Code
+```