Merge pull request #4 from xiaoshihou514/main

docs: adds demo video

README.md

@@ -2,6 +2,8 @@
 
 Blazingly fast, minimal lsp auto-completion and snippet plugin for neovim.
 
+[demo.webm](https://github.com/xiaoshihou514/epo.nvim/assets/108414369/e6df8be6-1cd3-4f53-96ba-023d785a0d1c)
+
 **Needs neovim nightly**
 
 **This plugin would be much more feature-complete after [this pr](https://github.com/neovim/neovim/pull/24723) is merged**
@@ -55,7 +57,7 @@ PmenuThumb
 ```
 
 <details>
-<summary>Click to show some mapping presets</summary>
+<summary>Click to show some config presets</summary>
 
 - <kbd>TAB</kbd> complete
 
@@ -88,6 +90,25 @@ vim.keymap.set('i', '<C-e>', function()
 end, {expr = true})
 ```
 
+- kind icons like in the demo
+```lua
+-- reference: onsails/lspkind.nvim
+local kind_icons = {
+    Text = "󰉿", Method = "󰆧", Function = "󰘧", Constructor = "", Field = "󰜢",
+    Variable = "󰀫", Class = "󰠱", Interface = "", Module = "", Property = "󰜢",
+    Unit = "󰑭", Value = "󰎠", Enum = "", Keyword = "󰌋", Snippet = "", Color = "󰏘",
+    File = "󰈙", Reference = "", Folder = "󰉋", EnumMember = "", Constant = "󰏿",
+    Struct = "", Event = "", Operator = "󰆕", TypeParameter = " ", Unknown = " ",
+}
+
+require("epo").setup {
+    kind_format = function(k)
+        return kind_icons[k] .. " " .. k
+    end
+}
+
+```
+
 - use `<cr>` to accept completion
 
 ```lua
@@ -102,12 +123,12 @@ end, { expr = true, noremap = true })
 -- nvim-autopair compatibility
 vim.keymap.set("i", "<cr>", function()
     if vim.fn.pumvisible() == 1 then
-        return "<C-y>"
+        return vim.api.nvim_replace_termcodes("<C-y>", true, true, true)
     end
     return require("nvim-autopairs").autopairs_cr()
-end, { expr = true, noremap = true })
+end, { expr = true, noremap = true, replace_keycodes = false })
+require("nvim-autopairs").setup({ map_cr = false })
 ```
-
 </details>
 
 ## License MIT