Skip to content
This repository has been archived by the owner on Jul 21, 2024. It is now read-only.

Commit

Permalink
docs: better README
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaoshihou514 committed Nov 23, 2023
1 parent 9e1d31d commit 7b3db28
Showing 1 changed file with 6 additions and 14 deletions.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
## Epo
## epo.nvim

a blazing fast and minimal less than 300 lines. neovim lsp auto-completion plugin.

**Need neovim nightly**
Blazing fast and minimal lsp auto-completion plugin for neovim.

**Needs neovim nightly**

## Usage

```lua
require('epo').setup({
-- default value of options.
fuzzy = false,
-- increase this value can aviod trigger complete when delete character.
debounce = 50,
Expand All @@ -20,22 +18,19 @@ require('epo').setup({
})
```

register capabilities for `vim.snippet`
You may want to pass the capabilities to your lsp

```lua
server_config = {
capabilities = vim.tbl_deep_extend(
local capabilities = vim.tbl_deep_extend(
'force',
vim.lsp.protocol.make_client_capabilities(),
require('epo').register_cap()
)
}
```

## Keymap

Super <kbd>TAB</kbd> and <kbd>Shift-tab</kbd> bind tab and shift-tab for completion and snippet
expand.
Supercharge <kbd>TAB</kbd> and <kbd>Shift-tab</kbd> for completion and snippet expansion.

```lua
vim.keymap.set('i', '<TAB>', function()
Expand Down Expand Up @@ -66,7 +61,4 @@ vim.keymap.set('i', '<C-e>', function()
end, {expr = true})
```


third param is fuzzy match enable.

## License MIT

0 comments on commit 7b3db28

Please sign in to comment.