diff --git a/README.md b/README.md index 0951a84..e693d8e 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,43 @@ variable = "some content" this allows for the docstring to show during completion +## Installation + +### neovim (lua) + +using [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) + +install `srls` into your path or give the `cmd` table entry the absolute path: + +```lua + +local nvim_lsp = require('lspconfig') + +nvim_lsp.srls.setup({ + cmd = {"srls"}, + filetypes = {"skill"}, + root_dir = root_pattern(".git") +}) +``` + +#### astronvim + +```lua +return { + lsp = { + servers = { + "skill_ls" + }, + config = { + skill_ls = function() + return { + cmd = { "srls" }, + filetypes = { "skill" }, + root_dir = require('lspconfig.util').root_pattern(".git"), + } + end, + } + } +} +``` +