Skip to content

Commit 1d8a160

Browse files
committed
docs(readme): add installation instructions
1 parent 6df1fad commit 1d8a160

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,47 @@ A [NetLinx][netlinx] plugin for [Neovim][neovim].
1010
- Syntax highlighting for NetLinx files.
1111
- Basic snippets for common NetLinx constructs.
1212

13+
## Installation
14+
15+
Using [lazy.nvim][lazy]:
16+
17+
[lazy]: https://lazy.folke.io/
18+
19+
```lua
20+
{
21+
"Norgate-AV/netlinx.nvim",
22+
opts = {},
23+
}
24+
```
25+
26+
Using [packer.nvim][packer]:
27+
28+
[packer]: https://github.com/wbthomason/packer.nvim
29+
30+
```lua
31+
use({
32+
"Norgate-AV/netlinx.nvim",
33+
config = function()
34+
require("netlinx").setup()
35+
end,
36+
})
37+
```
38+
39+
### Manual Installation
40+
41+
Clone the repository into your Neovim packages directory:
42+
43+
```bash
44+
git clone https://github.com/Norgate-AV/netlinx.nvim \
45+
~/.local/share/nvim/site/pack/plugins/start/netlinx.nvim
46+
```
47+
48+
Then add to your `init.lua`:
49+
50+
```lua
51+
require("netlinx").setup()
52+
```
53+
1354
## LICENSE
1455

1556
[MIT](./LICENSE)

0 commit comments

Comments
 (0)