neobrag/README.md

neobrag lets you brag to your fellow developers

# neobrag
neobrag helps you to brag about your code stats to your fellow devs; outputs a helpful pie chart of your exploits.

# Installation
The app is intended to be global; install with
```shell
npm i -g neobrag
```

# Configuration

Create a list of git repos in a file; the file can be named anything. Separate each repo with a newline (LF endings).

Call the following:

```shell
neobrag --config location_of_repos.txt
```

The app will create an internal config file and begin cloning the repos you specified. Note that these repos must have the _full_ URL in order to work.

# Name mapping

Have a lot of different devs? Maybe your email got switched partway through? You can use a JSON file to map names. Call it whatever you like, and enter something like this:

```json
{
    "A Terrible Name" : "My better name"
}
```

Then, call:

```shell
neobrag -u -q -n path_to_json.json
```

You should only need to do this once; if you need to update the name mapping file, call the above command again.

This will replace git blame names with whatever you choose to put.

# Requirements

This application is limited to anything that can run Bash; no Windows support unless you're using WSL or WSL2. It's the nature of the scripts used; there are no windows equivalents. The git-bash may work since it relies on simple commands, but YMMV.

# Example

Here's an example view of what many repos together look like; note that names have been removed since these are private.

[Example](example/example.png)