From b20b740941e75cd1dfd4acb2011f85071b25cf34 Mon Sep 17 00:00:00 2001
From: linrongbin16 <linrongbin16@outlook.com>
Date: Mon, 27 Nov 2023 14:06:39 +0800
Subject: [PATCH] docs(config): mention branch components (#162)

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index b2a5171..d6b75a2 100644
--- 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