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

Updated docs

Browse source
This commit is contained in:
Ionică Bizău 2020-08-09 14:58:56 +03:00
parent bd8f6de86a
commit 7c196e9099
5 changed files with 122 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -6,3 +6,4 @@ node_modules
*.env
.DS_Store
package-lock.json
.bloggify/*

2
LICENSE
View file

@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2015-19 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
Copyright (c) 2015-20 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

161
README.md
View file

@ -1,20 +1,47 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
[![git-stats](http://i.imgur.com/Q7TQYHx.png)](#)
# `$ git-stats`
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/git-stats.svg)](https://www.npmjs.com/package/git-stats) [![Downloads](https://img.shields.io/npm/dt/git-stats.svg)](https://www.npmjs.com/package/git-stats) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
> Local git statistics including GitHub-like contributions calendars.
I'd be curious to see your calendar with all your commits. Ping me on Twitter ([**@IonicaBizau**](https://twitter.com/IonicaBizau)). :smile: Until then, here's my calendar:
![](http://i.imgur.com/PpM0i3v.png)
![](http://i.imgur.com/PpM0i3v.png "")
## Contents
@ -30,6 +57,17 @@ I'd be curious to see your calendar with all your commits. Ping me on Twitter ([
- [How to contribute](#yum-how-to-contribute)
## :cloud: Installation
You can install the package globally and use it as command line tool:
@ -56,18 +94,18 @@ Local git statistics including GitHub-like contributions calendars.
Options:
-r, --raw Outputs a dump of the raw JSON data.
-g, --global-activity Shows global activity calendar in the current
repository.
-d, --data <path> Sets a custom data store file.
-l, --light Enables the light theme.
-n, --disable-ansi Forces the tool not to use ANSI styles.
-a, --authors Shows a pie chart with the author related
contributions in the current repository.
-u, --until <date> Optional end date.
-s, --since <date> Optional start date.
--record <data> Records a new commit. Don't use this unless you are
a mad scientist. If you are a developer just use
this option as part of the module.
-s, --since <date> Optional start date.
-u, --until <date> Optional end date.
-g, --global-activity Shows global activity calendar in the current
repository.
-n, --disable-ansi Forces the tool not to use ANSI styles.
-l, --light Enables the light theme.
-d, --data <path> Sets a custom data store file.
-a, --authors Shows a pie chart with the author related
contributions in the current repository.
-h, --help Displays this help.
-v, --version Displays version information.
@ -83,6 +121,12 @@ Your commit history is kept in ~/.git-stats by default. You can create
Documentation can be found at https://github.com/IonicaBizau/git-stats.
```
## Usage
### Importing and deleting commits
@ -123,20 +167,6 @@ $ cd repository-downloader
# Install the dependencies
$ npm install
# Enter your username and password for GitHub and BitBucket into the config.json
$ vim config.json
repository-downloader/config.json
- {
- "github": {
- "username": "your GitHub username",
- "password": "your GitHub password"
- },
- "bitbucket": {
- "username": "your BitBucket username",
- "password": "your BitBucket password"
- }
- }
# Start downloading and importing
$ ./start
```
@ -221,7 +251,7 @@ git-stats --raw | git-stats-html -o out.html
# Export data since 2015 (save the results in out.html)
git-stats --since '1 January 2015' --raw | git-stats-html -o out.html --big
git-stats --since '1 January 2015' --raw | ./bin/git-stats-html -o out.html --big
```
@ -255,18 +285,17 @@ If you run `git-stats` to display graph on Windows, please use a terminal that c
Cygwin Terminal is known to work, while Windows Command Prompt and Git Bash do not. Improvements are more than welcome! :dizzy:
## :clipboard: Example
Here is an example how to use this package as library. To install it locally, as library, you can do that using `npm` (or `yarn`):
```sh
# Using npm
npm install --save git-stats
# Using yarn
yarn add git-stats
```
Here is an example how to use this package as library. To install it locally, as library, you can use `npm install git-stats` (or `yarn add git-stats`):
@ -287,32 +316,53 @@ g1.ansiCalendar({
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :memo: Documentation
For full API reference, see the [DOCUMENTATION.md][docs] file.
## :newspaper: Press Highlights
- [*A GitHub-like contributions calendar, but locally, with all your git commits*, The Changelog](https://changelog.com/github-like-contributions-calendar-locally-git-commits/)
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
@ -331,28 +381,53 @@ However, if you get some profit from this or just want to encourage me to contin
Thanks! :heart:
## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
- `git-stats-fcc-importer`
- `git-stats-importer`
- [`git-stats-fcc-importer`](https://github.com/cmal/git-stats-fcc-importer#readme) (by Yu Zhao)—git-stats importer for FreeCodeCamp users
- [`git-stats-importer`](https://github.com/IonicaBizau/git-stats-importer)—Imports your commits from a repository into git-stats history.
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md

2
package-lock.json generated
View file

@ -1,6 +1,6 @@
{
"name": "git-stats",
"version": "2.10.11",
"version": "2.10.12",
"lockfileVersion": 1,
"requires": true,
"dependencies": {

2
package.json
View file

@ -286,4 +286,4 @@
"bloggify.json",
"bloggify/"
]
}
}