update keymapping override document and sample config

README.md

@@ -199,6 +199,8 @@ require.'navigator'.setup({
 
   default_mapping = true,  -- set to false if you will remap every key
   keymaps = {{key = "gK", func = "declaration()"}}, -- a list of key maps
+  -- this kepmap gK will override "gD" mapping function declaration()  in default kepmap
+  -- please check mapping.lua for all keymaps
   treesitter_analysis = true, -- treesitter variable context
   code_action_prompt = {enable = true, sign = true, sign_priority = 40, virtual_text = true},
   icons = {

lua/navigator.lua

@@ -5,11 +5,13 @@ _NgConfigValues = {
   preview_height = 0.35,
   height = 0.35,
   default_mapping = true,
+  keymaps = {{key = "GR", func = "references()"}}, -- e.g keymaps={{key = "gr", func = "references()"}, }
   combined_attach = "both", -- both: use both customized attach and navigator default attach, mine: only use my attach defined in vimrc
   on_attach = nil,
   -- function(client, bufnr)
   --   -- your on_attach will be called at end of navigator on_attach
   -- end,
+
   code_action_prompt = {enable = true, sign = true, sign_priority = 40, virtual_text = true},
   treesitter_analysis = true, -- treesitter variable context
   lsp = {

lua/navigator/lspclient/mapping.lua

@@ -76,6 +76,7 @@ local function set_mapping(user_opts)
       table.insert(key_maps, v)
     end
   end
+  -- log(key_maps)
 
   -- local key_opts = {vim.tbl_deep_extend("force", key_maps, unpack(result))}
   for _, value in pairs(key_maps) do