1487a2ad844bbdff24e1db1cfb086138f477c7e9

Author
Garth Mortensen <voldemortensen@users.noreply.github.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

urltools: add readme (#7126)

Diff

 1diff --git a/plugins/urltools/README.md b/plugins/urltools/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..548301c72443038f316b5832d406cc58ce3f448b
 4--- /dev/null
 5+++ b/plugins/urltools/README.md
 6@@ -0,0 +1,29 @@
 7+# URLTools plugin
 8+
 9+This plugin provides two aliases to URL-encode and URL-decode strings.
10+
11+To start using it, add the `urltools` plugin to your plugins array in `~/.zshrc`:
12+
13+```zsh
14+plugins=(... urltools)
15+```
16+
17+Original author: [Ian Chesal](https://github.com/ianchesal)
18+Original idea and aliases: [Ruslan Spivak](https://ruslanspivak.wordpress.com/2010/06/02/urlencode-and-urldecode-from-a-command-line/)
19+
20+## Commands
21+
22+| Command     | Description                  |
23+| :---------- | :--------------------------- |
24+| `urlencode` | URL-encodes the given string |
25+| `urldecode` | URL-decodes the given string |
26+
27+## Examples
28+
29+```zsh
30+urlencode 'https://github.com/robbyrussell/oh-my-zsh/search?q=urltools&type=Code'
31+# returns https%3A%2F%2Fgithub.com%2Frobbyrussell%2Foh-my-zsh%2Fsearch%3Fq%3Durltools%26type%3DCode
32+
33+urldecode 'https%3A%2F%2Fgithub.com%2Frobbyrussell%2Foh-my-zsh%2Fsearch%3Fq%3Durltools%26type%3DCode'
34+# returns https://github.com/robbyrussell/oh-my-zsh/search?q=urltools&type=Code
35+```