Skip to content

Commit 046a672

Browse files
committed
Make a second pass at the README
1 parent 39b0c65 commit 046a672

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
11
# Vim CommonMark
22

3-
[![Rust Build](https://img.shields.io/github/workflow/status/alerque/vim-commonmark/Rust?label=Rust)](https://github.com/alerque/vim-commonmark/actions?workflow=Rust)
3+
[![Cargo Build](https://img.shields.io/github/workflow/status/alerque/vim-commonmark/Rust?label=Cargo+Build)](https://github.com/alerque/vim-commonmark/actions?workflow=Rust)
44
[![Rust Code Format](https://img.shields.io/github/workflow/status/alerque/vim-commonmark/Rustfmt?label=Rustfmt&logo=Rust)](https://github.com/alerque/vim-commonmark/actions?workflow=Rustfmt)
55
[![VimL Lint Status](https://github.com/alerque/vim-commonmark/workflows/Vint/badge.svg)](https://github.com/alerque/vim-commonmark/actions?workflow=Vint)
66
[![Lua Lint Status](https://img.shields.io/github/workflow/status/alerque/vim-commonmark/Luacheck?label=Luacheck&logo=Lua)](https://github.com/alerque/vim-commonmark/actions?workflow=Luacheck)
77

8-
Vim syntax highlighting and filetype plugin for [CommonMark][commonmark] using the [pulldown-cmark][pulldown-cmark] parser to inform the parsing. Because the syntax is not cobbled together from regular expressions but informed by a reas parser it will only ever highlight 100% valid CommonMark syntax (no false positives!).
8+
Vim syntax plugin specifically targetting [CommonMark][commonmark] using the [pulldown-cmark][pulldown-cmark] parser to inform the highlighting. Because the syntax is not cobbled together from regular expressions but informed by a real parser it will only ever highlight 100% valid CommonMark syntax (no false positives!).
99

1010
Defaults options are for strict CommonMark mode, but some extensions are also available (footnotes, tables, task lists, strikethrough).
1111

1212
## Requirements
1313

14-
* Neovim (Support for VIM8 possible, contributions welcome) with Lua support
15-
* Rust build toolchain (during development, may provide binaries later)
16-
* GNU Make (at least during development, to be replaced by VimL install function later)
14+
* Neovim (Support for VIM8 would be possible, contributions welcome) with Lua support
15+
* Rust build toolchain (during development, binaries may be provided later)
16+
* GNU Make (during development, to be replaced by VimL install function later)
1717

1818
## Instructions
1919

20-
After installing plugin as usual, `cd` to the plugin directory and run `make`.
20+
Using `vim-plug`:
21+
22+
```viml
23+
:Plug 'alerque/vim-commonmark', {'do': 'make'}
24+
```
25+
26+
...or manually after installing via your usual method, run `make` from the plugin directory.
2127

2228
[commonmark]: https://commonmark.org
2329
[pulldown-cmark]: https://github.com/raphlinus/pulldown-cmark

0 commit comments

Comments
 (0)