diff --git a/README.md b/README.md index be51b2f..5a7922e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # todolist-syntax -Vim syntax file for todo lists. + +Vim syntax file for todo lists (**\*.td**). + +# Installation + +```shell +mkdir -p ~/.vim/syntax +wget -O ~/.vim/syntax/todolist.vim https://raw.githubusercontent.com/gechandesu/todolist-syntax/main/todolist.vim +echo 'autocmd BufRead,BufNewFile *.td set filetype=todolist' >> ~/.vim/filetype.vim +``` + +# Syntax + +``` +- Uncompleted task (blue) ++ Completed task (green) +x Rejected task (red) +# Comment (cyan) +TODO mark +Plain text +```