git-truck 0.0.0-1f51d21 → 0.0.0-22d1903

package/README.md

@@ -1,104 +1,44 @@
 # 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 is a tool that 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/). 
+Git Truck is a tool that provides you with a truckload of visualizations of your git repository.
 
-| Git Truck can help you figure out: | |
-|-|-|
-| Where the files in your codebase that only have a single contributor are (i.e., truck-factor = 1) | <img width="1912" alt="image" src="https://github.com/git-truck/git-truck/assets/1959615/1cc20716-0927-4aba-8d7d-115626bc445f"> |
-| How the various developers contribute to your codebase | <img width="1913" alt="image" src="https://github.com/git-truck/git-truck/assets/1959615/780852f3-28de-44d2-ab79-e4ef420c3736"> |
-| Which parts of the system that are most often changed | <img width="1912" alt="image" src="https://github.com/git-truck/git-truck/assets/1959615/8ca5f0b9-798f-40cd-b64e-de2fee00a5c3"> |
+With Git Truck you can:
 
-## [What makes Git Truck different?](#what-makes-git-truck-different)
-
-🔒 Private by design
-
-🏝️ Works offline
-
-🤷 Git provider agnostic - works with any git repository
+- See who worked on different parts of the project
+- Get an overview of the file structure
+- See where there is the most activity in your project
+- See how your project has looked at different points in time
 
-😊 No tracking, no ads, no data mining, no analytics, no cloud, no servers
+|                                                                                           |                                                                                               |
+| ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| <img src="./teaser-images/readme1.png" alt="Where has the most work been done recently?"> | <img src="./teaser-images/readme2.png" alt="Who worked on different subsystems in the past?"> |
 
-## [Prerequisites](#prerequisites)
-
-> [!IMPORTANT]  
-> To use Git Truck, you will need to have the following programs installed:
-> - [Node.js](https://nodejs.org/en/) 18.0.0 or newer and npm 10.0 or newer
-> - [git](https://git-scm.com/downloads) 2.29 or newer
-> 
-> Check your installed versions using `node --version`, `npm --version` and `git --version`. 
-
-> [!TIP]
-> The latests versions of Node and git can be installed from the links above. 
-
-> [!Note]
-> `npm` is automatically installed along with `node`.
+You can read more about the features in the [feature overview](https://git-truck.github.io/git-truck/GitTruckTeaser), [in papers about Git Truck](https://github.com/git-truck/papers/blob/master/README.md), or just try it and start exploring your projects!
 
 ## [Get started](#get-started)
 
-1. Within a git repository, or a directory containing git repositories, run the command
-
-```bash
-npx -y git-truck
-```
-
-2. The application will now open in your default browser.
-
-![Demo](demo.gif)
+1. In your terminal, navigate to a git repository or a folder containing several repositories
 
-## [Feedback](#feedback)
+2. Run the command `npm install -g git-truck@latest` to install or update Git Truck.
 
-Please open an issue [here](https://github.com/git-truck/git-truck/issues) where you describe your problem or feature request. For bug reports, please include git version, Node version, npm version, operating system, and an image of the problem would be great too!
+3. Now you can run Git Truck using the command `git truck`
 
-If you have any suggestions about new features, or things that you think should be different, also feel free to open an issue.
+4. The application will now open in your default browser. Happy trucking!
 
-## [Advanced use](#advanced-use)
-
-Run `npx git-truck` in the root of a git repository, that you want to visualize:
-
-```sh
-npx git-truck [args]
-```
-
-### [Arguments](#arguments)
-
-|         arg          |                              description                              |   default value    |
-| :------------------: | :-------------------------------------------------------------------: | :----------------: |
-|       `--path`       |                 path to a folder or a git repository                  | current directory  |
-|       `--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                     |         -          |
-
-> [!CAUTION]  
-> Using `--invalidate-cache` will cause the analyzer to run every time the client talks to the server. This can be very slow if working with large repositories.
-
-### [Configuration](#configuration)
-
-You can add a `truckconfig.json` file to the root of your project, where you can define the arguments you want.
-Additionally you can define which git-aliases should be considered as the same person using `unionedAuthors`. If provided, the first name in the array is used as the name of the person.
-You can also define files to ignore.
-
-**Example:**
+> [!NOTE]
+> To use Git Truck, you will need to have the following programs installed:
+>
+> - [Node.js](https://nodejs.org/en/) 22.0.0 or newer and npm 10.0 or newer
+> - [git](https://git-scm.com/downloads) 2.29 or newer
+>
+> Check your installed versions using `node --version`, `npm --version` and `git --version`.
 
-```json
-{
-  "log": "debug",
-  "branch": "main",
-  "unionedAuthors": [
-    ["Bob", "Bobby Bob"],
-    ["Alice", "aliiii", "alice alice"]
-  ],
-  "hiddenFiles": ["package-lock.json", "*.bin", "*.svg"],
-  "invalidateCache": true
-}
-```
+## [What makes Git Truck different?](#what-makes-git-truck-different)
 
-### Very large repositories
+🔒 Private by design
 
-> [!TIP]
-> If the repository you intend to analyze is very large (300k+ commits), we recommend to increase the memory available to nodejs by setting the environment variable `NODE_OPTIONS` to `--max-old-space-size=4096` before starting Git Truck, otherwise analyzation might crash.
-> If your repository has more than 1 million commits, it is unlikely that Git Truck can successfully analyze it, even with higher memory limit.
+🏝️ Works offline
 
-## Star History
+🤷 Git provider agnostic - works with any git repository
 
-[![Star History Chart](https://api.star-history.com/svg?repos=git-truck/git-truck&type=Date)](https://star-history.com/#git-truck/git-truck&Date)
+😊 No tracking, no ads, no cloud, no servers, no subscription