From 7d4f57a5cae11c41d21c75cebabceec47482d919 Mon Sep 17 00:00:00 2001 From: Masahiro Kasashima Date: Sat, 23 Sep 2023 11:10:49 +0900 Subject: [PATCH] Added description about priority and how to control it --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 4b7b43a..f6b4738 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,16 @@ All of the commands above optionally take a register, e.g. `:OpenInGHFileLines+` In this case, the URL will not be opened in the browser, but put into the register given. This is especially useful if you're running neovim on a remote machine, but want to open the URL locally. +## Priority + +At first, this plugin try to identify the page url based on the current branch you are working in, +and if it fails then switches its base to commit. + +This behavior can be inverted via bang `!`, e.g. `:OpenInGHFile!`. + +Since commit based url tends to have long durablity compared to branch based one, it can be useful in some situation. +It won't be affected by subsequent commits, branch deletion after merge, and so on. + ## Usage You can call the commands directly or define mappings them: