Mirror
/
git-stats
mirror of https://github.com/IonicaBizau/git-stats.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs

This commit is contained in:
Ionică Bizău 2015-01-26 10:08:43 +02:00
parent f360f23c3b
commit c580559d01
1 changed files with 4 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -2,12 +2,9 @@
A GitHub-like contributions calendar, but locally, with all your git commits.
## Installation
Run the following commands to download and install the application:
```sh
$ git clone https://github.com/IonicaBizau/git-stats.git git-stats
$ cd git-stats
$ npm install
$ npm install -g git-stats
```
## Documentation
@ -22,9 +19,6 @@ Records a new commit.
- **Function** `callback`: The callback function.
### Return
- ****
## `get(data, callback)`
Gets the git stats.
@ -32,11 +26,6 @@ Gets the git stats.
- **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