diff --git a/README.md b/README.md index 66dc2eaf..63a40f08 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,26 @@

- Codeium + Windsurf

--- [![Discord](https://img.shields.io/discord/1027685395649015980?label=community&color=5865F2&logo=discord&logoColor=FFFFFF)](https://discord.gg/3XFf78nAx5) -[![Twitter Follow](https://img.shields.io/badge/style--blue?style=social&logo=twitter&label=Follow%20%40codeiumdev)](https://twitter.com/intent/follow?screen_name=codeiumdev) -![License](https://img.shields.io/github/license/Exafunction/codeium.vim) -[![built with Codeium](https://codeium.com/badges/main)](https://codeium.com?repo_name=exafunction%2Fcodeium.vim) +[![Twitter Follow](https://img.shields.io/badge/style--blue?style=social&logo=twitter&label=Follow%20%40windsurf_ai)](https://twitter.com/intent/follow?screen_name=windsurf_ai) +![License](https://img.shields.io/github/license/Exafunction/windsurf.vim) +[![Docs](https://img.shields.io/badge/Windsurf%20Docs-09B6A2)](https://docs.windsurf.com) +[![Canny Board](https://img.shields.io/badge/Feature%20Requests-6b69ff)](https://windsurf.canny.io/feature-requests/) +[![built with Windsurf](https://windsurf.com/badges/main)](https://windsurf.com?repo_name=exafunction%2Fwindsurf.vim) [![Visual Studio](https://img.shields.io/visual-studio-marketplace/i/Codeium.codeium?label=Visual%20Studio&logo=visualstudio)](https://marketplace.visualstudio.com/items?itemName=Codeium.codeium) [![JetBrains](https://img.shields.io/jetbrains/plugin/d/20540?label=JetBrains)](https://plugins.jetbrains.com/plugin/20540-codeium/) [![Open VSX](https://img.shields.io/open-vsx/dt/Codeium/codeium?label=Open%20VSX)](https://open-vsx.org/extension/Codeium/codeium) [![Google Chrome](https://img.shields.io/chrome-web-store/users/hobjkcpmjhlegmobgonaagepfckjkceh?label=Google%20Chrome&logo=googlechrome&logoColor=FFFFFF)](https://chrome.google.com/webstore/detail/codeium/hobjkcpmjhlegmobgonaagepfckjkceh) -# codeium.vim +# windsurf.vim _Free, ultrafast Copilot alternative for Vim and Neovim_ -Codeium autocompletes your code with AI in all major IDEs. We [launched](https://www.codeium.com/blog/codeium-copilot-alternative-in-vim) this implementation of the Codeium plugin for Vim and Neovim to bring this modern coding superpower to more developers. Check out our [playground](https://www.codeium.com/playground) if you want to quickly try out Codeium online. +Windsurf autocompletes your code with AI in all major IDEs. We [launched](https://www.windsurf.com/blog/codeium-copilot-alternative-in-vim) this implementation of the Windsurf plugin for Vim and Neovim to bring this modern coding superpower to more developers. Check out our [playground](https://www.windsurf.com/playground) if you want to quickly try out Windsurf online. Contributions are welcome! Feel free to submit pull requests and issues related to the plugin. @@ -33,13 +35,13 @@ Contributions are welcome! Feel free to submit pull requests and issues related 1. Install [Vim](https://github.com/vim/vim) (at least 9.0.0185) or [Neovim](https://github.com/neovim/neovim/releases/latest) (at least 0.6) -2. Install `Exafunction/codeium.vim` using your vim plugin manager of +2. Install `Exafunction/windsurf.vim` using your vim plugin manager of choice, or manually. See [Installation Options](#-installation-options) below. -3. Run `:Codeium Auth` to set up the plugin and start using Codeium. +3. Run `:Codeium Auth` to set up the plugin and start using Windsurf. You can run `:help codeium` for a full list of commands and configuration -options, or see [this guide](https://www.codeium.com/vim_tutorial) for a quick tutorial on how to use Codeium. +options, or see [this guide](https://www.windsurf.com/vim_tutorial) for a quick tutorial on how to use Windsurf. ## 🛠️ Configuration @@ -48,17 +50,19 @@ A few of the most popular options are highlighted below. ### ⌨️ Keybindings -Codeium provides the following functions to control suggestions: +Windsurf provides the following functions to control suggestions: -|Action|Function|Default Binding| -|---|---|---| -|Clear current suggestion| `codeium#Clear()` |``| -|Next suggestion| `codeium#CycleCompletions(1)` |``| -|Previous suggestion| `codeium#CycleCompletions(-1)` |``| -|Insert suggestion| `codeium#Accept()` |``| -|Manually trigger suggestion| `codeium#Complete()` |``| +| Action | Function | Default Binding | +| --------------------------- | ------------------------------ | --------------- | +| Clear current suggestion | `codeium#Clear()` | `` | +| Next suggestion | `codeium#CycleCompletions(1)` | `` | +| Previous suggestion | `codeium#CycleCompletions(-1)` | `` | +| Insert suggestion | `codeium#Accept()` | `` | +| Manually trigger suggestion | `codeium#Complete()` | `` | +| Accept word from suggestion | `codeium#AcceptNextWord()` | `` | +| Accept line from suggestion | `codeium#AcceptNextLine()` | `` | -Codeium's default keybindings can be disabled by setting +Windsurf's default keybindings can be disabled by setting ```vim let g:codeium_disable_bindings = 1 @@ -66,7 +70,7 @@ let g:codeium_disable_bindings = 1 or in Neovim: -```vim +```lua vim.g.codeium_disable_bindings = 1 ``` @@ -75,9 +79,10 @@ use the `g:codeium_no_map_tab` option. If you'd like to bind the actions above to different keys, this might look something like the following in Vim: - ```vim imap