Ver Fonte

Update 'README.md'

isundil há 9 anos atrás
pai
commit
787cbc5167
1 ficheiros alterados com 49 adições e 62 exclusões
  1. 49 62
      README.md

+ 49 - 62
README.md

@@ -1,87 +1,74 @@
-JSONSTROLL(1)                    User Commands                   JSONSTROLL(1)
+# JsonStroller
 
-[![Build Status](http://b64.jenkins.knacki.info/job/jsonStroller/badge/icon)](http://b64.jenkins.knacki.info/job/jsonStroller/)
-
-NAME
-       jsonstroll  -  manual  page  for jsonstroll (jsonstroller suite) 1.0RC1
-       generated on Nov  5 2016
-
-SYNOPSIS
-       jsonstroll [OPTIONS]
-       jsonstroll [OPTIONS] FILENAME
-       jsonstroll [OPTIONS] --INPUT
-       jsonstroll --diff [OPTIONS] FILENAME FILENAME [FILENAME]
 
-DESCRIPTION
-       Read json input and print it using ncurse
-
-       if not INPUT nor FILENAME, use standard input
-
-       When output is redirected to a file or another command, output will  be
-       prettyfied unless --compress
+[![Build Status](http://b64.jenkins.knacki.info/job/jsonStroller/badge/icon)](http://b64.jenkins.knacki.info/job/jsonStroller/)
 
-       FILENAME
-              read input from filename instead of stdin
+## NAME
+jsonstroll  -  manual  page  for jsonstroll (jsonstroller suite) 1.2 generated on Nov  5 2016
 
-       INPUT  use this as input instead of stdin
+## SYNOPSIS
+    jsonstroll [OPTIONS]
+    jsonstroll [OPTIONS] FILENAME
+    jsonstroll [OPTIONS] -- INPUT
+    jsonstroll --diff [OPTIONS] FILENAME FILENAME
 
-       -W     consider continuing on non-blocking errors
+## DESCRIPTION
+Read json input and print it using ncurse
 
-       --ascii
-              ignore unicode values
+if not INPUT nor FILENAME, use standard input
 
-       --keep-order
-              do not sort objects by key
+When output is redirected to a file or another command, output will  be
+prettyfied unless --compress
 
-       --color[=MODE]
-              colorize  output,  MODE  can  be  never  or always (default when
-              ommited)
+``FILENAME``
+- read input from filename instead of stdin
 
-       --compress
-              if output is redirected, strip unnecessaries characters
+``INPUT``
+- use this as input instead of stdin
 
-       --diff-cmd COMMAND ;
-              Execute command as external diff. All following argument will be
-              passed  as  parameter  to  COMMAND until ';' is encountered. The
-              '{}' argument will be replaced by the file path of  the  pretti‐
-              fied input
+``-W``
+- consider continuing on non-blocking errors
 
-       -v, -version
-              display version information
+``--ascii``
+- ignore unicode values
 
-       -h, --help
-              show this message and exit
+``--keep-order``
+- do not sort objects by key
 
-EXAMPLES
-       jsonstroll f.json       Output f.json's content
+``--color[=MODE]``
+- colorize  output,  MODE  can  be  never  or always (default when ommited)
 
-       jsonstroll   --diff   fileA.json   fileB.json  compare  fileA.json  and
-       fileB.json
+``--compress``
+- if output is redirected, strip unnecessaries characters
 
-       jsonstroll --diff-cmd vimdiff {} ';' fileA.json fileB.json      compare
-       fileA.json and fileB.json
+``--diff-cmd COMMAND ;``
+- Execute command as external diff. All following argument will be passed  as  parameter  to  COMMAND until ';' is encountered. The '{}' argument will be replaced by the file path of  the  prettified input
 
-AUTHOR
-       Written by isundil <isundill@gmail.com>.
+``-v``, ``-version``
+- display version information
 
-REPORTING BUGS
-       Report bugs to <isundill@gmail.com>
+``-h``, ``--help``
+- show this message and exit
 
-COPYRIGHT
-       Copyright  ©  2016  Free Software Foundation, Inc.  License GPLv3+: GNU
-       GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
-       This is free software: you are free  to  change  and  redistribute  it.
-       There is NO WARRANTY, to the extent permitted by law.
+## EXAMPLES
+```sh
+       jsonstroll f.json
+          # Output f.json's content
 
-SEE ALSO
-       The  full  documentation for jsonstroll is maintained as a Texinfo man‐
-       ual.  If the info and jsonstroll programs  are  properly  installed  at
-       your site, the command
+       jsonstroll   --diff   fileA.json fileB.json
+          # compare  fileA.json  and fileB.json
 
-              info jsonstroll
+       jsonstroll --diff-cmd vimdiff {} \; fileA.json fileB.json
+          # compare fileA.json and fileB.json
+```
 
-       should give you access to the complete manual.
+## AUTHOR
+Written by ``isundil`` <isundill@gmail.com>.
 
+## REPORTING BUGS
+Report bugs to <isundill@gmail.com>
 
+## COPYRIGHT
+See [LICENSE](LICENSE)
 
 jsonstroll (jsonstroller suite) on Nov  5 2016  JSONSTROLL(1)