Skip to content

Commit b149eec

Browse files
committed
Updated docs
1 parent 67ae0c5 commit b149eec

File tree

3 files changed

+38
-12
lines changed

3 files changed

+38
-12
lines changed

DOCUMENTATION.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ Records a new commit.
4141
#### Return
4242
- **GitStats** The `GitStats` instance.
4343

44-
### `removeCommit(data, callback)`
44+
### `record(data, callback)`
45+
removeCommit
4546
Deletes a specifc commit from the history.
4647

4748
#### Params

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015-17 Ionică Bizău <[email protected]> (http://ionicabizau.net)
3+
Copyright (c) 2015-17 Ionică Bizău <[email protected]> (https://ionicabizau.net)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# `$ git-stats`
55

6-
[![Patreon](https://img.shields.io/badge/Support%20me%20on-Patreon-%23e6461a.svg)][patreon] [![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![AMA](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)
6+
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![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)
77

88
> Local git statistics including GitHub-like contributions calendars.
99
@@ -20,11 +20,9 @@ I'd be curious to see your calendar with all your commits. Ping me on Twitter ([
2020
- [Importing and deleting commits](#importing-and-deleting-commits)
2121
- [Importing all the commits from GitHub and BitBucket](#importing-all-the-commits-from-github-and-bitbucket)
2222
- [What about the GitHub Contributions calendar?](#what-about-the-github-contributions-calendar)
23-
2423
- [Documentation](#documentation)
2524
- [How to contribute](#how-to-contribute)
2625

27-
2826
## :cloud: Installation
2927

3028
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.
175173
[`git-stats-html`](https://github.com/IonicaBizau/git-stats-html) interprets the JSON data and generates an HTML file. Example:
176174

177175
```sh
176+
178177
# Install git-stats-html
178+
179179
npm install -g git-stats-html
180180

181+
182+
181183
# Export the data from the last year (generate out.html)
184+
182185
git-stats --raw | git-stats-html -o out.html
183186

187+
188+
184189
# Export data since 2015 (save the results in out.html)
190+
185191
git-stats --since '1 January 2015' --raw | ./bin/git-stats-html -o out.html --big
192+
186193
```
187194

188195
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/):
189196

190197
```sh
198+
191199
# Install pageres
200+
192201
npm install -g pageres-cli
193202

203+
204+
194205
# Generate the image from HTML
206+
195207
pageres out.html 775x250
208+
196209
```
197210

198211
## Cross-platform compatibility
@@ -238,20 +251,27 @@ For full API reference, see the [DOCUMENTATION.md][docs] file.
238251

239252
- [*A GitHub-like contributions calendar, but locally, with all your git commits*, The Changelog](https://changelog.com/github-like-contributions-calendar-locally-git-commits/)
240253

241-
242254
## :yum: How to contribute
243255
Have an idea? Found a bug? See [how to contribute][contributing].
244256

245257

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).
247262

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:
250264

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+
![](https://i.imgur.com/z6OQI95.png)
252271

253272
Thanks! :heart:
254273

274+
255275
## :dizzy: Where is this library used?
256276
If you are using this library in one of your projects, add it in this list. :sparkles:
257277

@@ -263,11 +283,16 @@ If you are using this library in one of your projects, add it in this list. :spa
263283

264284
[MIT][license] © [Ionică Bizău][website]
265285

286+
[badge_patreon]: http://ionicabizau.github.io/badges/patreon.svg
287+
[badge_amazon]: http://ionicabizau.github.io/badges/amazon.svg
288+
[badge_paypal]: http://ionicabizau.github.io/badges/paypal.svg
289+
[badge_paypal_donate]: http://ionicabizau.github.io/badges/paypal_donate.svg
266290
[patreon]: https://www.patreon.com/ionicabizau
291+
[amazon]: http://amzn.eu/hRo9sIZ
267292
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
268293
[donate-now]: http://i.imgur.com/6cMbHOC.png
269294

270-
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(http%3A%2F%2Fionicabizau.net)&year=2015#license-mit
271-
[website]: http://ionicabizau.net
295+
[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
296+
[website]: https://ionicabizau.net
272297
[contributing]: /CONTRIBUTING.md
273298
[docs]: /DOCUMENTATION.md

0 commit comments

Comments
 (0)