Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed May 25, 2016
1 parent 0f4f5ca commit 6a95f21
Showing 1 changed file with 26 additions and 19 deletions.
45 changes: 26 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,39 @@
# `$ git-stats-importer` [![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![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)

# `$ git-stats-importer`

[![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-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)

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

## Installation
## :cloud: Installation

You can install the package globally and use it as command line tool:


```sh
$ npm i -g git-stats-importer
```


Then, run `git-stats-importer --help` and see what the CLI tool can do.

```sh

```
$ git-stats-importer --help
Usage: git-stats-importer [options]
Options:
-f, --find-repos <path> If this option is provided, the importer will
search for repositories in the provided path
(recursively).
-d, --delete Delete the commits from selected repositories.
-f, --find-repos <path> If this option is provided, the importer will
search for repositories in the provided path
(recursively).
-d, --delete Delete the commits from selected repositories.
-e, --emails <emails> Comma separated emails you want to include in the
import process. By default it's the
$GIT_AUTHOR_EMAIL value.
-h, --help Displays this help.
-v, --version Displays version information.
import process. By default it's the
$GIT_AUTHOR_EMAIL value.
-h, --help Displays this help.
-v, --version Displays version information.
Examples:
git-stats-importer # imports the commits from the current repository
Expand All @@ -38,17 +44,20 @@ Examples:
Documentation can be found at https://github.com/IonicaBizau/git-stats-importer
```

## Example
## :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`:

```sh
$ npm i --save git-stats-importer
```



```js
// Dependencies
var GitStatsImporter = require("../");
var GitStatsImporter = require("git-stats-importer");

// Start importing
var importer = GitStatsImporter({
Expand Down Expand Up @@ -95,17 +104,15 @@ importer.on("finish", function (data) {
});
```

## Documentation
## :memo: Documentation

For full API reference, see the [DOCUMENTATION.md][docs] file.

## How to contribute
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].

## Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

## License
## :scroll: License

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

Expand All @@ -115,4 +122,4 @@ If you are using this library in one of your projects, add it in this list. :spa
[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
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[docs]: /DOCUMENTATION.md

0 comments on commit 6a95f21

Please sign in to comment.