Adding comments in installation examples

Adding comments to make it more obvious that the user need to replace `<CurrentMajor>`
Flimm · Apr 17, 2023 · 9ef39d4 · 9ef39d4
1 parent a6355b1
commit 9ef39d4
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ Neovim >= 0.5 (extmarks)
   use({
   	"L3MON4D3/LuaSnip",
   	-- follow latest release.
-  	tag = "v<CurrentMajor>.*",
+  	tag = "v<CurrentMajor>.*", -- Replace <CurrentMajor> by the latest released major (first number of latest release)
   	-- install jsregexp (optional!:).
   	run = "make install_jsregexp"
   })
@@ -44,15 +44,15 @@ Neovim >= 0.5 (extmarks)
   {
   	"L3MON4D3/LuaSnip",
   	-- follow latest release.
-  	version = "<CurrentMajor>.*",
+  	version = "<CurrentMajor>.*", -- Replace <CurrentMajor> by the latest released major (first number of latest release)
   	-- install jsregexp (optional!).
   	build = "make install_jsregexp"
   }
   ```
   **vim-plug**:
   ```vim
   " follow latest release and install jsregexp.
-  Plug 'L3MON4D3/LuaSnip', {'tag': 'v<CurrentMajor>.*', 'do': 'make install_jsregexp'}
+  Plug 'L3MON4D3/LuaSnip', {'tag': 'v<CurrentMajor>.*', 'do': 'make install_jsregexp'} " Replace <CurrentMajor> by the latest released major (first number of latest release)
   ```
   Check the `Releases`-section to the right for the latest major version.