From 190df69e2b79102d76e27238aaa114f87a1938a1 Mon Sep 17 00:00:00 2001 From: Alex Vear Date: Sun, 24 Feb 2019 00:26:29 +0000 Subject: [PATCH] Update README --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) 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