From bc5d54a984fc258031e6f5ca1427c984090c15e5 Mon Sep 17 00:00:00 2001 From: alemi Date: Fri, 9 Feb 2024 19:51:55 +0100 Subject: [PATCH] docs: added README.md --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b38e43e..ce4b02c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,24 @@ # gitts **git tui stats** is a terminal application to display git project informations -It's currently very work in progress, but shows a line chart with contributions per week per commit author +![the simplest gitts view, shoutout to mumble-web](https://cdn.alemi.dev/proj/gitts/gitts-basic-mumble-web.png) + +## about this +gitts displays statistics about contributors of your git repository in your terminal + +this is inspired by github's Insights>Contributors view, which is a cool way to gaze at the current state of a project + +gitts aims to give such informations directly in the cli, in different forms + +## installation +just +``` + $ CARGO_NET_GIT_FETCH_WITH_CLI=true cargo install --git https://git.alemi.dev/gitts.git +``` + +by default it gets bundled both ratatui (tui library) and egui (gui library) to provide both views + +it's possible to pick just one (or neither) of them with `--no-default-features --features=tui,gui` + +### screenshot +![tui screenshot, shoutout to zola](https://cdn.alemi.dev/proj/gitts/gitts-tui-zola.png)