Skip to content

Commit 3f81223

Browse files
committed
docs(git): update README.md
1 parent 1c2094c commit 3f81223

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

git.yazi/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,14 @@ ya pack -a yazi-rs/plugins:git
1818
Add the following to your `~/.config/yazi/init.lua`:
1919

2020
```lua
21-
require("git"):setup()
21+
-- This is the default options,
22+
-- you could call `setup` without arguments if you don't want to change them.
23+
require("git"):setup({
24+
-- The order in which the status icon is displayed
25+
order = 1500,
26+
-- Whether to include `renamed` files in the status (or treat them as `deleted` and `added`)
27+
renamed = false,
28+
})
2229
```
2330

2431
And register it as fetchers in your `~/.config/yazi/yazi.toml`:

git.yazi/main.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
---@field repos table<string, Changes> Mapping between a repository and the status of each of its files
99

1010
---@class Options
11-
---@field order number The order in which the status is displayed
12-
---@field renamed boolean Whether to include renamed files in the status (or treat them as modified)
11+
---@field order number The order in which the status icon is displayed
12+
---@field renamed boolean Whether to include `renamed` files in the status (or treat them as `deleted` and `added`)
1313

1414
local WINDOWS = ya.target_family() == "windows"
1515

0 commit comments

Comments
 (0)