Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lusingander committed Sep 1, 2024
1 parent e5a39c0 commit d25911c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ Usage: serie [OPTIONS]
Options:
-p, --protocol <TYPE> Image protocol to render graph [default: auto] [possible values: auto, iterm, kitty]
-o, --order <TYPE> Commit ordering algorithm [default: chrono] [possible values: chrono, topo]
--preload Preload all graph images
--no-cache Do not use graph image cache
-h, --help Print help
-V, --version Print version
Expand All @@ -101,6 +102,7 @@ Options:
#### -p, --protocol \<TYPE\>

A protocol type for rendering images of commit graphs.

By default `auto` will guess the best supported protocol for the current terminal.
Kitty terminals are detected as `kitty` via an environment variable, and all others are assumed to support `iterm`.

Expand All @@ -116,6 +118,12 @@ Refer to [Compatibility](#compatibility) for details.

<img src="./img/order-topo.png" width=500>

#### --preload

By default, graph images are generated and loaded lazily as needed.

If `--preload` is specified, all graph images will be generated and loaded at startup. This can result in smoother scrolling, as the images are already available, and might reduce memory usage. However, this may lead to slower startup times, especially for large repositories.

#### --no-cache

The generated graph image is saved in `$XDG_CACHE_HOME/serie` and reused.
Expand Down

0 comments on commit d25911c

Please sign in to comment.