📝 Update documentation

Author: lambdalisue

doc/gin.txt

@@ -16,6 +16,7 @@ INTERFACE			|gin-interface|
   COMMANDS			  |gin-commands|
   VARIABLES			  |gin-variables|
   FUNCTIONS			  |gin-functions|
+  COMPONENTS			  |gin-components|
   MAPPINGS			  |gin-mappings|
   ACTIONS			  |gin-actions|
 
@@ -347,6 +348,40 @@ gin#action#list_actions()
 gin#action#gather_candidates({range})
 	Gather and return candidates of the current buffer in {range}.
 
+-----------------------------------------------------------------------------
+COMPONENTS					*gin-components*
+
+Components are |Function| that return a string for |statusline| and |tabline|.
+The function will never throw errors and fail silently unless the denops is
+running as debug mode. Note that the result of function is cached shortly to
+keep performance.
+If no {worktree} is specified or an empty string, gin tries to find one like
+++worktree option explained in |gin-command-options|.
+
+					*gin#component#branch#ascii()*
+					*gin#component#branch#unicode()*
+gin#component#branch#ascii([{worktree}])
+gin#component#branch#unicode([{worktree}])
+	Return an indicator string of a current and upstream branches.
+>
+	set statusline+=(%{gin#component#branch#ascii()})
+<
+					*gin#component#traffic#ascii()*
+					*gin#component#traffic#unicode()*
+gin#component#traffic#ascii([{worktree}])
+gin#component#traffic#unicode([{worktree}])
+	Return an indicator string of the number of ahead and behind commits.
+>
+	set statusline+=[%{gin#component#traffic#ascii()}]
+<
+					*gin#component#worktree#full()*
+					*gin#component#worktree#name()*
+gin#component#worktree#full([{worktree}])
+gin#component#worktree#name([{worktree}])
+	Return an indicator string of the current worktree.
+>
+	set statusline+=%{gin#component#worktree#name()}
+<
 -----------------------------------------------------------------------------
 MAPPINGS					*gin-mappings*