diff --git a/README.md b/README.md index ef6fb8de26ba15bb7f2ed8a7cac30766cadfe7f5..1564d8ae350b7c84e8c21973bee1566f9969ab58 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,14 @@ A Python script to load and filter a JSON file, showing the nested-key structure The first argument should be the JSON filename. -Following arguments are optional, and are one or more of: +The following filter arguments are optional and are one or more of: -+regex : any key in the path must match the regex (like "grep") --regex : no key in the path can match the regex (like "grep -v") -$regex : the final key in the path must match the regex (note: you may have to - escape the $ in your terminal) -^regex : the first key in the path must match the regex +- `+regex` : any key in the path must match the regex (like "grep") +- `-regex` : no key in the path can match the regex (like "grep -v") +- `$regex` : the final key in the path must match the regex (note: you may have to escape the $ in your terminal) +- `^regex` : the first key in the path must match the regex +`regex` means Regular Expression. While you can use simple strings, these will be interpreted as regular expressions. If you are not familiar with these, you might want to start at https://en.wikipedia.org/wiki/Regular_expression . Requires various standard Python modules that, if not available, are easily