summaryrefslogtreecommitdiffstats
path: root/zsh/oh-my-zsh/plugins/urltools/README.md
diff options
context:
space:
mode:
authorLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2022-10-03 21:42:20 +0530
committerLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2022-10-03 21:42:20 +0530
commitaf120ab348f2e1a5a39dec035ed9dcf84189a64e (patch)
tree2a3aadd7ce1b7b771dfe3fe7c983569726c8d7ed /zsh/oh-my-zsh/plugins/urltools/README.md
downloaddotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.tar.gz
dotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.tar.bz2
dotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.zip
dotfiles
Diffstat (limited to 'zsh/oh-my-zsh/plugins/urltools/README.md')
-rw-r--r--zsh/oh-my-zsh/plugins/urltools/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/zsh/oh-my-zsh/plugins/urltools/README.md b/zsh/oh-my-zsh/plugins/urltools/README.md
new file mode 100644
index 0000000..29c3710
--- /dev/null
+++ b/zsh/oh-my-zsh/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/ohmyzsh/ohmyzsh/search?q=urltools&type=Code'
+# returns https%3A%2F%2Fgithub.com%2Fohmyzsh%2Fohmyzsh%2Fsearch%3Fq%3Durltools%26type%3DCode
+
+urldecode 'https%3A%2F%2Fgithub.com%2Fohmyzsh%2Fohmyzsh%2Fsearch%3Fq%3Durltools%26type%3DCode'
+# returns https://github.com/ohmyzsh/ohmyzsh/search?q=urltools&type=Code
+```