Skip to content

Commit 94f192c

Browse files
committed
readme: add lazy.nvim and jsregexp-install instructions to examples.
1 parent 500981f commit 94f192c

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,40 @@ https://user-images.githubusercontent.com/41961280/122515860-5179fa00-d00e-11eb-
2424

2525
# Requirements
2626
Neovim >= 0.5 (extmarks)
27-
`jsregexp` for lsp-snippet-transformations (see [here](https://github.com/L3MON4D3/LuaSnip/blob/master/DOC.md#transformations) for some tips on installing it)
27+
`jsregexp` for lsp-snippet-transformations (see [here](https://github.com/L3MON4D3/LuaSnip/blob/master/DOC.md#transformations) for some tips on installing it).
2828

2929
# Setup
3030
## Install
31-
* With your preferred plugin manager i.e. [vim-plug](https://github.com/junegunn/vim-plug) or [packer](https://github.com/wbthomason/packer.nvim)
32-
* LuaSnip uses [Semantic Versioning](https://semver.org) (with some leeway, big patches might end up as a Minor version)!
33-
Releases will be tagged as `vMajor.Minor.Patch`, we recommend following the latest Major release.
34-
35-
Packer:
31+
* With your preferred plugin manager i.e. [vim-plug](https://github.com/junegunn/vim-plug), [Packer](https://github.com/wbthomason/packer.nvim) or [lazy](https://github.com/folke/lazy.nvim)
32+
**Packer**:
33+
```lua
34+
use({
35+
"L3MON4D3/LuaSnip",
36+
-- follow latest release.
37+
tag = "v<CurrentMajor>.*",
38+
-- install jsregexp (optional!:).
39+
run = "make install_jsregexp"
40+
})
41+
```
42+
**lazy**:
3643
```lua
37-
use({"L3MON4D3/LuaSnip", tag = "v<CurrentMajor>.*"})
44+
{
45+
"L3MON4D3/LuaSnip",
46+
-- follow latest release.
47+
version = "<CurrentMajor>.*",
48+
-- install jsregexp (optional!).
49+
build = "make install_jsregexp"
50+
}
3851
```
39-
vim-plug:
52+
**vim-plug**:
4053
```vim
41-
Plug 'L3MON4D3/LuaSnip', {'tag': 'v<CurrentMajor>.*'}
54+
" follow latest release and install jsregexp.
55+
Plug 'L3MON4D3/LuaSnip', {'tag': 'v<CurrentMajor>.*', 'do': 'make install_jsregexp'}
4256
```
57+
Check the `Releases`-section to the right for the latest major version.
58+
59+
* LuaSnip uses [Semantic Versioning](https://semver.org) (with some leeway, big patches might end up as a Minor version)!
60+
Releases will be tagged as `vMajor.Minor.Patch`, we recommend following the latest Major release.
4361
Consider watching the repos releases so you're notified when a new version becomes available.
4462

4563
## Keymaps

0 commit comments

Comments
 (0)