Skip to content

Commit

Permalink
Add an installation section to the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
elementsean authored and tsandall committed Nov 21, 2019
1 parent 00047bf commit 56bc6b4
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

A Vim plugin for the Rego language that includes support for syntax highlighting.

## Installation

The rego-vim plugin can be installed the old fashion way, by copying them into your `~/.vim` directory, or
using any of the plugin managers (Vundle, etc).

### Vundle Installation

In your `.vimrc` file add the line `Plugin 'tsandall/vim-rego'`, like so:

```
call vundle#begin()
Plugin 'VundleVim/Vundle.vim'
" ... other plugins here ...
Plugin 'tsandall/vim-rego'
" ... more plugins ...
" All of your Plugins must be added before the following line
call vundle#end() " required
```

## Formatting

You can configure Vim to automatically format your Rego policies using `opa
Expand Down

0 comments on commit 56bc6b4

Please sign in to comment.