mirror of
https://github.com/IonicaBizau/git-stats.git
synced 2024-12-22 13:22:11 +01:00
Added the README file.
This commit is contained in:
parent
1972c656db
commit
f360f23c3b
1 changed files with 52 additions and 0 deletions
52
README.md
Normal file
52
README.md
Normal file
|
@ -0,0 +1,52 @@
|
|||
# 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:
|
||||
|
||||
```sh
|
||||
$ 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](./LICENSE) file.
|
Loading…
Reference in a new issue