Mirror/git-stats
1
0
Fork 0
mirror of https://github.com/IonicaBizau/git-stats.git synced 2024-12-22 13:22:11 +01:00
Code Issues Projects Releases Packages Wiki Activity

Docs

Browse source
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

19
README.md
View file

@ -2,41 +2,30 @@
A GitHub-like contributions calendar, but locally, with all your git commits. A GitHub-like contributions calendar, but locally, with all your git commits.
## Installation ## Installation
Run the following commands to download and install the application:
```sh ```sh
$ git clone https://github.com/IonicaBizau/git-stats.git git-stats $ npm install -g git-stats
$ cd git-stats
$ npm install
``` ```
## Documentation ## Documentation
## `record(data, callback)` ## `record(data, callback)`
Records a new commit. Records a new commit.
### Params ### Params
- **Object** `data`: The commit data containing: - **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` - `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. - `url` (String): The repository remote url.
- `hash` (String): The commit hash. - `hash` (String): The commit hash.
- **Function** `callback`: The callback function. - **Function** `callback`: The callback function.
### Return
- ****
## `get(data, callback)` ## `get(data, callback)`
Gets the git stats. Gets the git stats.
### Params ### Params
- **Object** `data`: The stats filter. **Not yet implemented**. - **Object** `data`: The stats filter. **Not yet implemented**.
- **Function** `callback`: The callback function. - **Function** `callback`: The callback function.
### Return
- ****
## How to contribute ## How to contribute
1. File an issue in the repository, using the bug tracker, describing the 1. File an issue in the repository, using the bug tracker, describing the