docs(config): mention branch components (#162)

linrongbin16 · Nov 27, 2023 · b20b740 · b20b740
1 parent f5e8fef
commit b20b740
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -456,6 +456,11 @@ require("gitlinker").setup({
 })
 ```
 
+> Here use the two branch components:
+>
+> - `lk.default_branch`(`_A.DEFAULT_BRANCH`): retrieved from `git rev-parse --abbrev-ref origin/HEAD`.
+> - `lk.current_branch`(`_A.CURRENT_BRANCH`): retrieved from `git rev-parse --abbrev-ref HEAD`.
+
 Then use it just like `blame`:
 
 ```vim