aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorThomas Vigouroux <tomvig38@gmail.com>2021-07-18 19:10:23 +0200
committerStephan Seitz <stephan.seitz@fau.de>2021-09-17 21:06:36 +0200
commit2b4ab852bf42362fa275f4a9d0ede57b1da10b2e (patch)
tree7360c1216e407e0d47bfbbc428cb43819744422d /README.md
parentDon't capture quotes as comments (diff)
downloadnvim-treesitter-2b4ab852bf42362fa275f4a9d0ede57b1da10b2e.tar
nvim-treesitter-2b4ab852bf42362fa275f4a9d0ede57b1da10b2e.tar.gz
nvim-treesitter-2b4ab852bf42362fa275f4a9d0ede57b1da10b2e.tar.bz2
nvim-treesitter-2b4ab852bf42362fa275f4a9d0ede57b1da10b2e.tar.lz
nvim-treesitter-2b4ab852bf42362fa275f4a9d0ede57b1da10b2e.tar.xz
nvim-treesitter-2b4ab852bf42362fa275f4a9d0ede57b1da10b2e.tar.zst
nvim-treesitter-2b4ab852bf42362fa275f4a9d0ede57b1da10b2e.zip
docs: notify about 0.5-compat in the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4ef2e9777..289ef252f 100644
--- a/README.md
+++ b/README.md
@@ -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).