diff --git a/README.md b/README.md index ec2e682..fbf0069 100644 --- a/README.md +++ b/README.md @@ -50,13 +50,38 @@ use {'ray-x/navigator.lua', requires = {'ray-x/guihua.lua', run = 'cd lua/fzy && lua require'navigator'.setup() ``` +## Sample vimrc + +```vim +call plug#begin('~/.vim/plugged') + +Plug 'neovim/nvim-lspconfig' +Plug 'ray-x/guihua.lua', {'do': 'cd lua/fzy && make' } +Plug 'ray-x/navigator.lua' + +call plug#end() + +lua < or `:q!` to kill the floating window, to move and to open location or apply changes +Please refer to lua/navigator/lspclient/mapping.lua on key mappings. Should be able to work out-of-box. + +- Use \ or `:q!` to kill the floating window +- to move +- \ to open location or apply code actions ## Screenshots +colorschema: [aurora](https://github.com/ray-x/aurora) + ### Reference ![reference](https://github.com/ray-x/files/blob/master/img/navigator/ref.gif?raw=true) @@ -87,6 +112,9 @@ Show diagnostic in files ![code actions](https://github.com/ray-x/files/blob/master/img/navigator/codeaction.jpg?raw=true) +Fill struct with gopls +![code actions fill struct](https://github.com/ray-x/files/blob/master/img/navigator/fill_struct.gif?raw=true) + ### Code preview with highlight ![code preview](https://github.com/ray-x/files/blob/master/img/navigator/preview_with_hl.jpg?raw=true) @@ -112,4 +140,8 @@ Treetsitter symbols in all buffers - Early phase, bugs expected - Async (some of the requests is slow on large codebase and might be good to use co-rountine) -- More clients. I use go, python, js/ts, java, c/cpp, lua most of the time. Do not test other languages (e.g rust, swift etc) +- More clients. I use go, python, js/ts, java, c/cpp, lua most of the time. Do not test other languages (e.g dart, swift etc) + +``` + +```