Skip to content

Improve docs #28

Open
Open
@Fetz

Description

@Fetz

readme

  • add gif's/asciicinema/svg-term-cli to show command line options
  • add link to the try online
  • add text of the ghpage on the readme

examples:

add to the readme how to read the response:

meta non verbose:

key description
size.raw non gzip size (utf8-length)
size.gzip gzip size (pako+utf8-length)

example:

{
    "__meta__": {
        "size": {
            "raw": "2.71 kB",
            "gzip": "1.53 kB"
        }
    }
}

meta verbose:

key description
size.value non gzip size, non pretty
size.raw non gzip size (utf8-length)
size.gzip gzip size (pako+utf8-length)
number_of_childs nr of childs in that node
parent_relative_percentage size of the node % relative to the parent node
biggest_node_child biggest node child

example:

"__meta__": {
    "size": {
        "value": 2698,
        "raw": "2.7 kB",
        "gzip": "1.49 kB"
    },
    "number_of_childs": 3,
    "parent_relative_percentage": "99.557%",
    "biggest_node_child": "servlet"
}

man

  • improve docs to show all the options of json-analyzer in the command line

use man instead of directory https://docs.npmjs.com/files/package.json#man

ghpage

  • add gifs that were added in the readme page

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsdocumentation (man, markdown, githubpage)

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions