From b149eec70252b4686dbebc1a17b5531cc7af7b33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Mon, 20 Mar 2017 19:18:24 +0200 Subject: [PATCH] Updated docs --- DOCUMENTATION.md | 3 ++- LICENSE | 2 +- README.md | 45 +++++++++++++++++++++++++++++++++++---------- 3 files changed, 38 insertions(+), 12 deletions(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index fe4e00a..9e0a12b 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -41,7 +41,8 @@ Records a new commit. #### Return - **GitStats** The `GitStats` instance. -### `removeCommit(data, callback)` +### `record(data, callback)` +removeCommit Deletes a specifc commit from the history. #### Params diff --git a/LICENSE b/LICENSE index de2574f..394cf21 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2015-17 Ionică Bizău (http://ionicabizau.net) +Copyright (c) 2015-17 Ionică Bizău (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 diff --git a/README.md b/README.md index 17e423e..fb513fa 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # `$ git-stats` - [![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) + [![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) > Local git statistics including GitHub-like contributions calendars. @@ -20,11 +20,9 @@ I'd be curious to see your calendar with all your commits. Ping me on Twitter ([ - [Importing and deleting commits](#importing-and-deleting-commits) - [Importing all the commits from GitHub and BitBucket](#importing-all-the-commits-from-github-and-bitbucket) - [What about the GitHub Contributions calendar?](#what-about-the-github-contributions-calendar) - - [Documentation](#documentation) - [How to contribute](#how-to-contribute) - ## :cloud: Installation 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. [`git-stats-html`](https://github.com/IonicaBizau/git-stats-html) interprets the JSON data and generates an HTML file. Example: ```sh + # Install git-stats-html + npm install -g git-stats-html + + # Export the data from the last year (generate out.html) + 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 | ./bin/git-stats-html -o out.html --big + ``` 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/): ```sh + # Install pageres + npm install -g pageres-cli + + # Generate the image from HTML + pageres out.html 775x250 + ``` ## Cross-platform compatibility @@ -238,20 +251,27 @@ For full API reference, see the [DOCUMENTATION.md][docs] file. - [*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]. -## :moneybag: Donations +## :sparkling_heart: Support my projects -Another way to support the development of my open-source modules is -to [set up a recurring donation, via Patreon][patreon]. :rocket: +I open-source almost everything I can, and I try to reply 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). -[PayPal donations][paypal-donations] are appreciated too! Each dollar helps. +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: + + - Starring and sharing the projects you like :rocket: + - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: + - [![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). + - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6` + + ![](https://i.imgur.com/z6OQI95.png) 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: @@ -263,11 +283,16 @@ If you are using this library in one of your projects, add it in this list. :spa [MIT][license] © [Ionică Bizău][website] +[badge_patreon]: http://ionicabizau.github.io/badges/patreon.svg +[badge_amazon]: http://ionicabizau.github.io/badges/amazon.svg +[badge_paypal]: http://ionicabizau.github.io/badges/paypal.svg +[badge_paypal_donate]: http://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 [donate-now]: http://i.imgur.com/6cMbHOC.png -[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 -[website]: http://ionicabizau.net +[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