Skip to content

Commit

Permalink
Update the clients/vim/README.md (TabbyML#253)
Browse files Browse the repository at this point in the history
Added a section that explains how to install the extension on packer and lazy.
  • Loading branch information
pauchiner authored Jun 19, 2023
1 parent 69084d4 commit 41c747e
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions clients/vim/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,39 @@

## Getting started

### Plug
### 🔌 Vim-Plug
```
" Make sure that the filetype plugin has been enabled.
filetype plugin on
" Assume using vim-plug as plugin manager
" Add this to the vim-plug config
Plug 'TabbyML/tabby', {'rtp': 'clients/vim'}
" Set URL of Tabby server
let g:tabby_server_url = 'http://127.0.0.1:8080'
```
### 📦 Packer and Lazy
In this case, you first need to clone the repo in your machine
```
git clone https://github.com/TabbyML/tabby.git ~/tabby
```
Then on the config file:
```
" For lazy
return { name = "tabby", dir = '~/tabby/clients/vim', enabled = true }
" For packer
use {'~/tabby/clients/vim', as = 'tabby', enabled = true}
" Set URL of Tabby server
" With Lua
vim.g.tabby_server_url = 'http://127.0.0.1:8080'
" With VimScript
let g:tabby_server_url = 'http://127.0.0.1:8080'
```
> In the future, the ideal would be to export the Vim extension to a separate Git repository. This would simplify the installation process [#252](https://github.com/TabbyML/tabby/issues/252).
## Usage

Expand Down

0 comments on commit 41c747e

Please sign in to comment.