Skip to content

Commit 8c07456

Browse files
authored
Update README.md (#1)
1 parent 204a30c commit 8c07456

File tree

2 files changed

+57
-21
lines changed

2 files changed

+57
-21
lines changed

Diff for: README.md

+48-21
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,47 @@
1-
# Codeium.vim
1+
<p align="center">
2+
<img width="300" alt="Codeium" src="codeium.svg"/>
3+
</p>
24

3-
## Getting started
5+
---
6+
7+
[![Discord](https://img.shields.io/discord/1027685395649015980?label=community&color=5865F2&logo=discord&logoColor=FFFFFF)](https://discord.gg/3XFf78nAx5)
8+
[![Twitter Follow](https://img.shields.io/twitter/follow/codeiumdev)](https://twitter.com/intent/follow?screen_name=codeiumdev)
9+
![License](https://img.shields.io/github/license/Exafunction/codeium.vim)
10+
11+
[![Visual Studio](https://img.shields.io/visual-studio-marketplace/d/Codeium.codeium?label=Visual%20Studio&logo=visualstudio)](https://marketplace.visualstudio.com/items?itemName=Codeium.codeium)
12+
[![JetBrains](https://img.shields.io/jetbrains/plugin/d/20540?label=JetBrains)](https://plugins.jetbrains.com/plugin/20540-codeium/)
13+
[![Open VSX](https://img.shields.io/open-vsx/dt/Codeium/codeium?label=Open%20VSX)](https://open-vsx.org/extension/Codeium/codeium)
14+
[![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)
15+
16+
# codeium.vim
17+
18+
_Free, ultrafast Copilot alternative for Vim and Neovim_
19+
20+
Codeium autocompletes your code with AI in all major IDEs. This repository contains the implementation of the Codeium plugin for Vim and Neovim. Check out our [playground](https://www.codeium.com/playground) if you want to quickly try out Codeium online.
21+
22+
Contributions are welcome! Feel free to submit pull requests and issues related to the plugin.
23+
24+
![Example](https://user-images.githubusercontent.com/1908017/213154744-984b73de-9873-4b85-998f-799d92b28eec.gif)
25+
26+
## 🚀 Getting started
427

528
1. Install [Vim](https://github.com/vim/vim) (at least 9.0.0185) or [Neovim](https://github.com/neovim/neovim/releases/latest) (at
6-
least 0.6)
29+
least 0.6)
730

8-
2. Install `Exafunction/codeium.vim` using your vim plugin manager of
9-
choice, or manually. See [Installation Options](#installation-options) below.
31+
2. Install `Exafunction/codeium.vim` using your vim plugin manager of
32+
choice, or manually. See [Installation Options](#-installation-options) below.
1033

1134
3. Run `:Codeium Auth` to set up the plugin and start using Codeium.
1235

1336
You can run `:help codeium` for a full list of commands and configuration
1437
options.
1538

16-
## Configuration
39+
## 🛠️ Configuration
1740

1841
Codeium can be disabled for particular filetypes by setting the
1942
`g:codeium_filetypes` variable in your vim config file (vimrc/init.vim):
2043

21-
```vimscript
44+
```vim
2245
let g:codeium_filetypes = {
2346
\ "bash": v:false,
2447
\ "typescript": v:true,
@@ -27,47 +50,51 @@ let g:codeium_filetypes = {
2750

2851
Codeium is enabled by default for most filetypes.
2952

30-
You can also *disable* codeium by default with the `g:codeium_enabled`
53+
You can also _disable_ codeium by default with the `g:codeium_enabled`
3154
variable:
3255

33-
```vimscript
56+
```vim
3457
let g:codeium_enabled = v:false
3558
```
3659

3760
For a full list of configuration options you can run `:help codeium`.
3861

39-
## Installation Options
62+
## 💾 Installation Options
4063

41-
### vim-plug
42-
```
64+
### 🔌 vim-plug
65+
66+
```vim
4367
Plug 'Exafunction/codeium.vim'
4468
```
4569

46-
### Vundle
47-
```
70+
### 📦 Vundle
71+
72+
```vim
4873
Plugin 'Exafunction/codeium.vim'
4974
```
5075

51-
### packer.nvim:
52-
```
76+
### 📦 packer.nvim:
77+
78+
```vim
5379
use 'Exafunction/codeium.vim'
5480
```
5581

56-
### Manual
82+
### 💪 Manual
5783

58-
#### Vim
84+
#### 🖥️ Vim
5985

6086
Run the following. On windows, you can replace `~/.vim` with
6187
`$HOME/vimfiles`:
62-
```
88+
89+
```bash
6390
git clone https://github.com/Exafunction/codeium.vim ~/.vim/pack/Exafunction/start/codeium.vim
6491
```
6592

66-
#### Neovim
93+
#### 💻 Neovim
6794

6895
Run the following. On windows, you can replace `~/.config` with
6996
`$HOME/AppData/Local`:
7097

71-
```
98+
```bash
7299
git clone https://github.com/Exafunction/codeium.vim ~/.config/nvim/pack/Exafunction/start/codeium.vim
73100
```

Diff for: codeium.svg

+9
Loading

0 commit comments

Comments
 (0)