Mirror
/
git-stats
mirror of https://github.com/IonicaBizau/git-stats.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
🍀 Local git statistics including GitHub-like contributions calendars.
20 Commits 1 Branch 52 Tags 5.7 MiB
HTML 86.6%
JavaScript 12.5%
Shell 0.9%
Go to file
Ionică Bizău f360f23c3b Added the README file. 2015-01-26 10:08:11 +02:00
bin Removed debugger. 2015-01-26 10:04:34 +02:00
lib JSDoc comment. 2015-01-26 10:05:46 +02:00
.gitignore Added gitignore. 2015-01-25 21:50:10 +02:00
LICENSE Added license. 2015-01-26 10:04:06 +02:00
README.md Added the README file. 2015-01-26 10:08:11 +02:00
package.json Updated the main file. 2015-01-26 10:07:33 +02:00

README.md

git-stats

A GitHub-like contributions calendar, but locally, with all your git commits.

Installation

Run the following commands to download and install the application:

$ git clone https://github.com/IonicaBizau/git-stats.git git-stats
$ cd git-stats
$ npm install

Documentation

record(data, callback)

Records a new commit.

Params

  • Object data: The commit data containing:

  • date (String|Date): The date object or a string in this format: DDD MMM dd HH:mm:ss YYYY

  • url (String): The repository remote url.

  • hash (String): The commit hash.

  • Function callback: The callback function.

Return

get(data, callback)

Gets the git stats.

Params

  • Object data: The stats filter. Not yet implemented.
  • Function callback: The callback function.

Return

How to contribute

  1. File an issue in the repository, using the bug tracker, describing the contribution you'd like to make. This will help us to get you started on the right foot.
  2. Fork the project in your account and create a new branch: your-great-feature.
  3. Commit your changes in that branch.
  4. Open a pull request, and reference the initial issue in the pull request message.

License

See the LICENSE file.