diff --git a/README.md b/README.md index a775e07..8ce1c7d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # Org-mode syntax highlighting for Vim -TODO: test with other colorthemes -TODO: fix italics -TODO: fix hyperlinks +This is a minimal [Org-mode](https://orgmode.org/) plugin for Vim. It provides +only the absolute necessities (e.g. syntax highlighting, indentation, folding, +etc.). The goal of this plugin is to replicate Vim's existing +[Markdown](https://github.com/tpope/vim-markdown/) editing experience for +Org-mode files. + +**NOTE**: This plugin is still a work in progress. + +- **TODO**: test with other colorthemes +- **TODO**: fix italics +- **TODO**: fix hyperlinks