Update README

2021-05-28 22:51:24 +02:00 · 2021-05-28 22:51:24 +02:00 · ef1e551f91
parent 672fb317c4
commit ef1e551f91
1 changed files with 11 additions and 0 deletions
--- a/README.rst
+++ b/README.rst
@ -1,3 +1,14 @@
 ==============================
 A Tree-sitter parser for CMake
 ==============================
+
+This project provides a `cmake` parser. Its primary use case is to provide a `cmake` parser for `nvim-treesitter`. The
+project is still underdevelopment but basic highlighting should already work.
+
+TODO
+====
+
+- [ ] Add grammar rules for comments:
+  - [ ] Bracket Comment
+  - [ ] Line Comment
+- [ ] Create an quoted argument external scanner