docs: notify about 0.5-compat in the readme

This commit is contained in:
Thomas Vigouroux 2021-07-18 19:10:23 +02:00 committed by Stephan Seitz
parent 17cf76de8a
commit 20b5dd9893

View file

@ -41,6 +41,10 @@ Please consider the experience with this plug-in as experimental until Neovim 0.
You can find the current roadmap [here](https://github.com/nvim-treesitter/nvim-treesitter/projects/1).
The roadmap and all features of this plugin are open to change, and any suggestion will be highly appreciated!**
*If you want to use this plugin with Neovim 0.5, please use the
0.5-compat branch. Be aware though that most improvements will require
neovim nightly.*
Nvim-treesitter is based on three interlocking features: [**language parsers**](#language-parsers), [**queries**](#adding-queries), and [**modules**](#available-modules), where *modules* provide features e.g., highlighting based on *queries* for syntax objects extracted from a given buffer by *language parsers*.
Users will generally only need to interact with parsers and modules as explained in the next section.
For more detailed information on setting these up, see ["Advanced setup"](#advanced-setup).