You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35-10Lines changed: 35 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
# `$ git-stats`
5
5
6
-
[][patreon][][paypal-donations][](https://github.com/IonicaBizau/ama)[](https://www.npmjs.com/package/git-stats)[](https://www.npmjs.com/package/git-stats)[](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
6
+
[![Support me on Patreon][badge_patreon]][patreon][![Buy me a book][badge_amazon]][amazon][![PayPal][badge_paypal_donate]][paypal-donations][](https://www.npmjs.com/package/git-stats)[](https://www.npmjs.com/package/git-stats)
7
7
8
8
> Local git statistics including GitHub-like contributions calendars.
9
9
@@ -20,11 +20,9 @@ I'd be curious to see your calendar with all your commits. Ping me on Twitter ([
20
20
-[Importing and deleting commits](#importing-and-deleting-commits)
21
21
-[Importing all the commits from GitHub and BitBucket](#importing-all-the-commits-from-github-and-bitbucket)
22
22
-[What about the GitHub Contributions calendar?](#what-about-the-github-contributions-calendar)
23
-
24
23
-[Documentation](#documentation)
25
24
-[How to contribute](#how-to-contribute)
26
25
27
-
28
26
## :cloud: Installation
29
27
30
28
You can install the package globally and use it as command line tool:
@@ -175,24 +173,39 @@ Since it's a js file, you can `require` any other modules there.
175
173
[`git-stats-html`](https://github.com/IonicaBizau/git-stats-html) interprets the JSON data and generates an HTML file. Example:
176
174
177
175
```sh
176
+
178
177
# Install git-stats-html
178
+
179
179
npm install -g git-stats-html
180
180
181
+
182
+
181
183
# Export the data from the last year (generate out.html)
184
+
182
185
git-stats --raw | git-stats-html -o out.html
183
186
187
+
188
+
184
189
# Export data since 2015 (save the results in out.html)
After we have the HTML file, we can generate an image file using [`pageres`](https://github.com/sindresorhus/pageres) by [**@sindresorhus**](https://github.com/sindresorhus/):
189
196
190
197
```sh
198
+
191
199
# Install pageres
200
+
192
201
npm install -g pageres-cli
193
202
203
+
204
+
194
205
# Generate the image from HTML
206
+
195
207
pageres out.html 775x250
208
+
196
209
```
197
210
198
211
## Cross-platform compatibility
@@ -238,20 +251,27 @@ For full API reference, see the [DOCUMENTATION.md][docs] file.
238
251
239
252
-[*A GitHub-like contributions calendar, but locally, with all your git commits*, The Changelog](https://changelog.com/github-like-contributions-calendar-locally-git-commits/)
240
253
241
-
242
254
## :yum: How to contribute
243
255
Have an idea? Found a bug? See [how to contribute][contributing].
244
256
245
257
246
-
## :moneybag: Donations
258
+
## :sparkling_heart: Support my projects
259
+
260
+
I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously,
261
+
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).
247
262
248
-
Another way to support the development of my open-source modules is
249
-
to [set up a recurring donation, via Patreon][patreon]. :rocket:
263
+
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
250
264
251
-
[PayPal donations][paypal-donations] are appreciated too! Each dollar helps.
265
+
- Starring and sharing the projects you like :rocket:
266
+
-[![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
267
+
-[![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
268
+
-**Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
269
+
270
+

252
271
253
272
Thanks! :heart:
254
273
274
+
255
275
## :dizzy: Where is this library used?
256
276
If you are using this library in one of your projects, add it in this list. :sparkles:
257
277
@@ -263,11 +283,16 @@ If you are using this library in one of your projects, add it in this list. :spa
0 commit comments