Usage not immediately clear about git-stats HOT 5 CLOSED

@M-Zuber That's very good point. In fact, I have the same feeling, but it's a good thing to get the feedback of a real user. 😄

I'm thinking that you maybe can add a section before the Installation one summarizing the things a little bit from the user perspective. I tried my best to make it clear, but I'm a developer. 😁

You will have to write it as JSON and generate it using blah (I will do that). If it's too complicated to write it as JSON, feel free to write markdown and I will convert it to JSON. 😄

from git-stats.

I will try and do it later today.
The JSON should be just the new section?

from git-stats.

@M-Zuber Yes, so something like this:

...
        "[How to contribute](#how-to-contribute)"
        ]
      },
      { "h2": "The section you're adding" },
      { "p": "Something you want to write" }
    ],
    "installation_command": {
...

from git-stats.

{ "h2": "Quick Start" },
      { "p": "Once you've installed git-stats, run the command from within the project directory" }

Something like this.
I apologize, but currently I do not have the time to properly learn the syntax and add more information like

//Go to project directory
cd path/to/your/repo

Also there seems to be a bug with the importer that I will try and file when I get the chance

from git-stats.

We're now displaying the help output in README.md, which contains examples as well. Feel free to create a pull request for improving the docs. 📝

from git-stats.