diff --git a/README.md b/README.md index b397380..ed07c48 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ -# Shows symbols idk -![demo](https://github.com/simrat39/rust-tools-demos/raw/master/symbols-demo.gif) \ No newline at end of file +# symbols-outline.nvim + A tree like view for symbols in Neovim using the Language Server Protocol. Supports all your favourite languages. + +![demo](https://github.com/simrat39/rust-tools-demos/raw/master/symbols-demo.gif) + +# Prerequisites + +- `neovim 0.5+` (nightly) + +# Installation + +using `vim-plug` + +```vim +Plug 'simrat39/symbols-outline.nvim' +``` + +# Setup +```lua +local opts = { + -- whether to highlight the currently hovered symbol + -- disable if your cpu usage is higher than you want it + -- or you just hate the highlight + -- default: true + highlight_hovered_item = true, +} + +require('symbols-outline').setup(opts) +``` + +## Commands +```vim +SymbolsOutline +``` +## Keymaps +```vim +Escape --> Close Outline +Enter --> GoTo Symbol location in code +``` \ No newline at end of file