Skip to content

Commit

Permalink
update readme (#436)
Browse files Browse the repository at this point in the history
Co-authored-by: Saransh Saini <[email protected]>
  • Loading branch information
saranshsaini and Saransh Saini authored Aug 21, 2024
1 parent 0b74f27 commit 72f89c8
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,15 @@ A few of the most popular options are highlighted below.

Codeium provides the following functions to control suggestions:

| Action | Function | Default Binding |
| --------------------------- | ------------------------------ | --------------- |
| Clear current suggestion | `codeium#Clear()` | `<C-]>` |
| Next suggestion | `codeium#CycleCompletions(1)` | `<M-]>` |
| Previous suggestion | `codeium#CycleCompletions(-1)` | `<M-[>` |
| Insert suggestion | `codeium#Accept()` | `<Tab>` |
| Manually trigger suggestion | `codeium#Complete()` | `<M-Bslash>` |
| Action | Function | Default Binding |
| --------------------------- | ------------------------------ | --------------- |
| Clear current suggestion | `codeium#Clear()` | `<C-]>` |
| Next suggestion | `codeium#CycleCompletions(1)` | `<M-]>` |
| Previous suggestion | `codeium#CycleCompletions(-1)` | `<M-[>` |
| Insert suggestion | `codeium#Accept()` | `<Tab>` |
| Manually trigger suggestion | `codeium#Complete()` | `<M-Bslash>` |
| Accept word from suggestion | `codeium#AcceptNextWord()` | `<C-k>` |
| Accept line from suggestion | `codeium#AcceptNextLine()` | `<C-l>` |

Codeium's default keybindings can be disabled by setting

Expand All @@ -77,6 +79,8 @@ If you'd like to bind the actions above to different keys, this might look somet

```vim
imap <script><silent><nowait><expr> <C-g> codeium#Accept()
imap <script><silent><nowait><expr> <C-h> codeium#AcceptNextWord()
imap <script><silent><nowait><expr> <C-j> codeium#AcceptNextLine()
imap <C-;> <Cmd>call codeium#CycleCompletions(1)<CR>
imap <C-,> <Cmd>call codeium#CycleCompletions(-1)<CR>
imap <C-x> <Cmd>call codeium#Clear()<CR>
Expand Down

0 comments on commit 72f89c8

Please sign in to comment.