Explain concept better in README
roryokane opened this issue · 1 comments
I read the README, but didn’t understand the concept until I read two external comments: this and this.
The first one links to https://github.com/gelstudios as an example of the results of Gitfiti. It would help to include both that link, so people know exactly where to find their “github account's commit history calendar”, and a screenshot like this:
The second link implies that Gitfiti accomplishes this by putting false dates in your fake project’s commit history. You should state that in the README. Before reading that, I thought you would actually have to wait a year and run Gitfiti every day in order to change your calendar, making the project impractical and uninteresting.
Your right, I should explain in the README what is going on more clearly.