Skip to content

Commit ca1dc76

Browse files
committed
Clarify wording/grammar + addt. info
1 parent 061169e commit ca1dc76

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
1-
![Vim support](https://img.shields.io/badge/vim-support-brightgreen.svg?style=flat-square)
2-
![Vim support](https://img.shields.io/badge/neovim-support-brightgreen.svg?style=flat-square)
1+
![Vim support](https://img.shields.io/badge/vim-unsupported-red.svg?style=flat-square)
2+
![Vim support](https://img.shields.io/badge/neovim-supported-green.svg?style=flat-square)
33
![GitHub release](https://img.shields.io/github/release/semanser/vim-outdated-plugins.svg?style=flat-square)
44

55
# vim-outdated-plugins
66

7-
Async plugin for showing number of your outdated plugins.
7+
A remote plugin for showing the number of and automatically updating outdated
8+
plugins managed via [vim-plug](https://github.com/junegunn/vim-plug)
89

9-
## What it does?
10+
## What does it do?
1011

11-
This plugin automatically checks if any of your plugins are outdated and displays a message about that.
12+
This plugin provides a mechanism for displaying a message indicating whether any
13+
of your plugins are outdated and display a message. It can also optionally
14+
trigger an update if needed.
1215

13-
To use this plugin make sure you have **git** installed.
16+
To use this plugin, make sure you are using [neovim](https://neovim.io/), have
17+
[git](https://git-scm.com) installed, and are using
18+
[vim-plug](https://github.com/junegunn/vim-plug) as your plugin manager
1419

1520
## Installation
1621

22+
Add the following line inside of the `call plug#begin()` section of your
23+
`init.vim`:
24+
1725
```vim
1826
Plug 'thisisrandy/vim-outdated-plugins'
1927
```
@@ -27,6 +35,7 @@ let g:outdated_plugins_silent_mode = 1
2735
" Trigger :PlugUpdate as needed
2836
let g:outdated_plugins_trigger_mode = 1
2937
38+
" This line is required to check for outdated plugins on startup
3039
autocmd VimEnter * call CheckOutdatedPlugins()
3140
```
3241

0 commit comments

Comments
 (0)