mirror of
https://github.com/chshersh/zbg.git
synced 2024-11-20 19:47:10 +03:00
Add demo images to README.md
This commit is contained in:
parent
552c48ff24
commit
42835a3027
28
README.md
28
README.md
@ -5,19 +5,17 @@
|
||||
|
||||
`zbg` (short for **Z**ero **B**ullshit **G**it) is a CLI tool for using `git` efficiently.
|
||||
|
||||
> ℹ️ **DISCLAIMER:** `zbg` is developed and maintained in free time
|
||||
> by volunteers. The development may continue for decades or may stop
|
||||
> tomorrow. You can use
|
||||
> [GitHub Sponsorship](https://github.com/sponsors/chshersh) to support
|
||||
> the development of this project.
|
||||
|
||||
## Features
|
||||
|
||||
* ✨ Prettier `git status`, `git log` and other commands
|
||||
* 🚀 Sane defaults to `git` commands that enforce good state of your local repository
|
||||
* 🌌 Achieving more by typing less
|
||||
|
||||
> **Warning**
|
||||
| `zbg status` | `zbg log` |
|
||||
| --- | --- |
|
||||
| ![zbg status](./images/zbg-status-demo.png) | ![zbg log](./images/zbg-log-demo.png) |
|
||||
|
||||
> **Note**
|
||||
> `zbg` is not a full `git` replacement!
|
||||
>
|
||||
> `zbg` provides helpful commands for the most
|
||||
@ -134,6 +132,13 @@ explanations.
|
||||
| `zbg uncommit` | `git reset HEAD~1` |
|
||||
| `zbg unstash` | `git stash pop` |
|
||||
|
||||
The following tables provides the comparison of `zbg` and `git` outputs.
|
||||
|
||||
| `zbg` | `git` |
|
||||
| ----- | ----- |
|
||||
| `zbg status` <br /> ![zbg status](./images/zbg-status-comparison.png) | `git status` <br /> ![git status](./images/git-status-comparison.png) |
|
||||
| `zbg log` <br /> ![zbg log](./images/zbg-log-comparison.png) | `git log` <br /> ![git log](./images/git-log-comparison.png) |
|
||||
|
||||
## For contributors
|
||||
|
||||
Check [CONTRIBUTING.md](https://github.com/chshersh/zbg/blob/main/CONTRIBUTING.md)
|
||||
@ -177,3 +182,12 @@ run the following command to sync with the remote and set the `origin/HEAD` ref
|
||||
```shell
|
||||
git remote set-head origin -a
|
||||
```
|
||||
|
||||
## Acknowledgement
|
||||
|
||||
> **Note**
|
||||
> `zbg` is developed and maintained in free time
|
||||
> by volunteers. The development may continue for decades or may stop
|
||||
> tomorrow. You can use
|
||||
> [GitHub Sponsorship](https://github.com/sponsors/chshersh) to support
|
||||
> the development of this project.
|
||||
|
BIN
images/git-log-comparison.png
Normal file
BIN
images/git-log-comparison.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 68 KiB |
BIN
images/git-status-comparison.png
Normal file
BIN
images/git-status-comparison.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 62 KiB |
BIN
images/zbg-log-comparison.png
Normal file
BIN
images/zbg-log-comparison.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 56 KiB |
BIN
images/zbg-log-demo.png
Normal file
BIN
images/zbg-log-demo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 46 KiB |
BIN
images/zbg-status-comparison.png
Normal file
BIN
images/zbg-status-comparison.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 31 KiB |
BIN
images/zbg-status-demo.png
Normal file
BIN
images/zbg-status-demo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 42 KiB |
@ -374,7 +374,7 @@ let fmt_diff_stats (change_summaries : change_summary list) : string =
|
||||
let file = fill_right file_size change.file in
|
||||
let change_count = fill_left change_count_size change.change_count in
|
||||
let stat = format_diff_stat change.diff_stat in
|
||||
Printf.sprintf "%s %s | %s %s" patch_type file change_count stat
|
||||
Printf.sprintf " %s %s | %s %s" patch_type file change_count stat
|
||||
in
|
||||
|
||||
unlines (List.map ~f:format_row change_summaries)
|
||||
|
Loading…
Reference in New Issue
Block a user