git-truck 0.0.0-98ab3ba → 0.0.0-a7e15cd

package/README.md

@@ -1,27 +1,24 @@
-# Git Truck 🚛
+# Git Truck 🚛 ·
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/git-truck/git-truck/blob/main/LICENSE)
+[![Git Truck on NPM](https://img.shields.io/npm/v/git-truck)](https://www.npmjs.com/git-truck)
 
-Git-Truck provides you with a truckload of visualizations for your git repository, and find out if your project has a good [truck factor](https://www.agileadvice.com/2005/05/15/agilemanagement/truck-factor/):
+![Demo](demo.gif)
 
+Git-Truck provides you with a truckload of visualizations for your git repository, and helps you find out if your project has a good [truck factor](https://www.agileadvice.com/2005/05/15/agilemanagement/truck-factor/):
 
-### 1. The files in your system where you have a single contributor (i.e., truck-factor = 1)
+| | |
+|-|-|
+| The files in your system where you have a single contributor (i.e., truck-factor = 1) | <img width="1912" alt="image" src="https://user-images.githubusercontent.com/464519/167393939-8d683732-4583-44fe-99a3-36c818761bcb.png"> |
+| You can see how the various developers contribute to your codebase | <img width="1913" alt="image" src="https://user-images.githubusercontent.com/464519/167394548-ca66665a-a699-44d7-8a97-bc7309c72f8a.png"> |
+| You can determine which parts of the system that are most often changed | <img width="1912" alt="image" src="https://user-images.githubusercontent.com/464519/167395118-6a4f50f4-5f37-4e0d-bcc8-144797b83e65.png"> |
 
-<img width="1912" alt="image" src="https://user-images.githubusercontent.com/464519/167393939-8d683732-4583-44fe-99a3-36c818761bcb.png">
 
+### What makes Git Truck different?
 
-### 2. How the various developers contribute to your codebase
-
-<img width="1913" alt="image" src="https://user-images.githubusercontent.com/464519/167394548-ca66665a-a699-44d7-8a97-bc7309c72f8a.png">
-
-
-
-### 3. The parts of the system that are most often changed
-
-<img width="1912" alt="image" src="https://user-images.githubusercontent.com/464519/167395118-6a4f50f4-5f37-4e0d-bcc8-144797b83e65.png">
-
-
-### 4. You can also merge multiple developer accounts
-
-<img width="1907" alt="image" src="https://user-images.githubusercontent.com/464519/167394405-67bd5b5d-be50-444e-8a1f-68af083a6cba.png">
+- Private by design
+- Works offline
+- Git provider agnostic - Works with any Git repository
+- No tracking, no ads, no data mining, no analytics, no cloud, no servers
 
 
 ## [Prerequisites](#prerequisites)
@@ -36,9 +33,8 @@ To check if these programs are installed, and what version you have, run `node -
 
 ## [Get started](#get-started)
 
-1. Within a git repository, or a directory containing git repositories, run the command `npx git-truck@latest`.
-2. Press `y` if it asks you to download the package.
-3. The application will now open in your default browser.
+1. Within a git repository, or a directory containing git repositories, run the command `npx -y git-truck`.
+2. The application will now open in your default browser.
 
 **Git Truck is part of a research study, so please fill out our [short survey](https://forms.gle/9wCCAw6zae7wuwZQ6) after trying out the tool. Thanks!**
 
@@ -64,6 +60,7 @@ npx git-truck [args]
 |       `--log`        | output log level. See [here](./src/analyzer/log.server.ts) for values |         -          |
 |       `--port`       |                      port to use for the program                      |        3000        |
 | `--invalidate-cache` |                    bypass analyzer cache manually                     |         -          |
+| `--headless`         |       run the program without opening the browser                     |         -          |
 
 **Note:** Using `--invalidate-cache` will cause the analyzer to run every time the client talks to the server.