summaryrefslogtreecommitdiff
path: root/plugins/jsontools/README.md
diff options
context:
space:
mode:
authorBob Williams <bobwilliams.ii@gmail.com>2014-03-26 18:47:57 -0400
committerBob Williams <bobwilliams.ii@gmail.com>2014-03-26 18:47:57 -0400
commit0605d53fa7f04c864e7bc5f9f68bd38f24fbbfd5 (patch)
tree4afefa3fdfd0e8b3d7f6dfe1aac8c9d817f5da3d /plugins/jsontools/README.md
parent982b534ce8cdf439c96bc48ff58f890e9e350d30 (diff)
downloadzsh-0605d53fa7f04c864e7bc5f9f68bd38f24fbbfd5.tar.gz
zsh-0605d53fa7f04c864e7bc5f9f68bd38f24fbbfd5.tar.bz2
zsh-0605d53fa7f04c864e7bc5f9f68bd38f24fbbfd5.zip
adding urlencode_json and associated README.md details
Diffstat (limited to 'plugins/jsontools/README.md')
-rw-r--r--plugins/jsontools/README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/plugins/jsontools/README.md b/plugins/jsontools/README.md
index 309ce9b5f..975d2bb79 100644
--- a/plugins/jsontools/README.md
+++ b/plugins/jsontools/README.md
@@ -6,7 +6,13 @@ Handy command line tools for dealing with json data.
- **pp_json** - pretty prints json
- **is_json** - returns true if valid json; false otherwise
+- **urlencode_json** - returns a url encoded string for the given json
+## Usage
+Usage is simple...just take your json data and pipe it into the appropriate jsontool.
+```sh
+<json data> | <jsontools tool>
+```
## Examples
##### pp_json
@@ -14,22 +20,16 @@ Handy command line tools for dealing with json data.
```sh
# curl json data and pretty print the results
curl https://coderwall.com/bobwilliams.json | pp_json
-
-# pretty print the contents of an existing json file
-less data.json | pp_json
-
-# json data directly from the command line
-echo '{"b":2, "a":1}' | pp_json
```
##### is_json
```sh
-# curl json data and pretty print the results
-curl https://coderwall.com/bobwilliams.json | is_json
-
# pretty print the contents of an existing json file
less data.json | is_json
+```
+##### urlencode_json
+```sh
# json data directly from the command line
-echo '{"b":2, "a":1}' | is_json
+echo '{"b":2, "a":1}' | urlencode_json
``` \ No newline at end of file