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

Revised grammar in the readme.md

Browse source
This commit is contained in:
Tyler 2015-02-09 11:13:52 -05:00
parent c70ecec82e
commit 18900f3e31
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -2,7 +2,7 @@
# `$ git-stats` # `$ git-stats`
A GitHub-like contributions calendar, but locally, with all your git commits. A GitHub-like contributions calendar, but locally, with all your git commits.
BTW, these are all my real commits in the last year. These are all real commits from the last year.
![](http://i.imgur.com/LfLJAaE.png) ![](http://i.imgur.com/LfLJAaE.png)
@ -12,7 +12,7 @@ $ npm install -g git-stats
``` ```
### Catching the `git commit` command ### Catching the `git commit` command
Would you like to catch store automatically the commits when you do `git commit`? Would you like to catch and automatically store the commits when you do `git commit`?
If so, put the following lines in your `~/.bashrc` (or `~/.bash_profile` on OS X) file: If so, put the following lines in your `~/.bashrc` (or `~/.bash_profile` on OS X) file:
@ -75,16 +75,16 @@ examples:
git-stats '1 January 2012' # All the commits from 1 January 2012, to now git-stats '1 January 2012' # All the commits from 1 January 2012, to now
git-stats '1 January 2012' '31 December 2012' # All the commits from 2012 git-stats '1 January 2012' '31 December 2012' # All the commits from 2012
Your commit history is keept in the .git-stats, in your $HOME directory (~/) Your commit history is kept in the .git-stats, in your $HOME directory (~/)
Documentation can be found at https://github.com/IonicaBizau/git-stats Documentation can be found at https://github.com/IonicaBizau/git-stats
``` ```
If you overriden the `git` command with a function, then your commits will be automatically recorded. If you override the `git` command with a function, then your commits will be automatically recorded.
### Importing and deleting commits ### Importing and deleting commits
I know it's not nice to start from scratch your git commit calendar. That's why I I know it's not nice to start your git commit calendar from scratch. That's why I
created a `git-stats-importer`, that imports or deletes the commits from a repository. created a `git-stats-importer` that imports or deletes the commits from a repository.
Check it out here: https://github.com/IonicaBizau/git-stats-importer Check it out here: https://github.com/IonicaBizau/git-stats-importer
@ -105,7 +105,7 @@ $ git-stats-importer --delete
``` ```
### Importing all the commits from GitHub and BitBucket ### Importing all the commits from GitHub and BitBucket
Yes, you read correctly! That's also possible. I [build a tool for that too](https://github.com/IonicaBizau/repository-downloader)! Yes, you read correctly! That's also possible. I [built a tool for that too](https://github.com/IonicaBizau/repository-downloader)!
```sh ```sh
# Download the repository downloader # Download the repository downloader
@ -132,11 +132,11 @@ $ npm install -g ghcal
$ ghcal ionicabizau $ ghcal ionicabizau
``` ```
Fore more detailed documentation checkout the repository: https://github.com/IonicaBizau/ghcal. Fore more detailed documentation, check out the repository: https://github.com/IonicaBizau/ghcal.
## Documentation ## Documentation
If you want to use this as module, this is possible. See the content below. If you want to use this as a module, that is possible. See the content below.
### `record(data, callback)` ### `record(data, callback)`
Records a new commit. Records a new commit.