From effb187d12c92898d3e1ba39200264cb77484248 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Sun, 9 Aug 2020 15:00:37 +0300 Subject: [PATCH] Updated docs --- .gitignore | 1 + LICENSE | 2 +- README.md | 119 ++++++++++++++++++++++++++++++++++++++++++++------- package.json | 2 +- 4 files changed, 106 insertions(+), 18 deletions(-) diff --git a/.gitignore b/.gitignore index af96bda..2ca2591 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ node_modules *.env .DS_Store package-lock.json +.bloggify/* diff --git a/LICENSE b/LICENSE index d21973e..f43e830 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2015-19 Ionică Bizău (https://ionicabizau.net) +Copyright (c) 2015-20 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 13e6288..1ced955 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,54 @@ + + + + + + + + + + + + + + + + # `$ git-stats-importer` [![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-importer.svg)](https://www.npmjs.com/package/git-stats-importer) [![Downloads](https://img.shields.io/npm/dt/git-stats-importer.svg)](https://www.npmjs.com/package/git-stats-importer) [![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) Buy Me A Coffee + + + + + + > Imports your commits from a repository into git-stats history. + + + + + This tool imports commits into the [`git-stats`](https://github.com/IonicaBizau/git-stats) commit history. If you like to import all your commits from BitBucket and GitHub, check out the [Repository Downloader project](https://github.com/IonicaBizau/repository-downloader). + + + + + + + + + + + ## :cloud: Installation You can install the package globally and use it as command line tool: @@ -52,18 +90,23 @@ Examples: Documentation can be found at https://github.com/IonicaBizau/git-stats-importer ``` -## :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-importer -# Using yarn -yarn add git-stats-importer -``` + + + + + + + + +## :clipboard: Example + + + +Here is an example how to use this package as library. To install it locally, as library, you can use `npm install git-stats-importer` (or `yarn add git-stats-importer`): @@ -118,27 +161,48 @@ importer.on("finish", function (data) { + + + + + + + + ## :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. + + + + + + + + + + + ## :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). @@ -158,21 +222,44 @@ Thanks! :heart: + + + + + + + + + + + + + + + + + + + + + ## :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 diff --git a/package.json b/package.json index 0796ba2..cd68fee 100644 --- a/package.json +++ b/package.json @@ -67,4 +67,4 @@ "bloggify.json", "bloggify/" ] -} \ No newline at end of file +}