benbot/nvim-treesitter
1
0
Fork 0
mirror of https://github.com/nvim-treesitter/nvim-treesitter.git synced 2026-07-17 10:50:06 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: remove advice to use 0.5-compat

Browse source 
0.5-compat branch was not actively maintained and nvim-treesitter
also runs with stable versions. We should be able to maintain
compatibility with latest stable by fall-back implementations in case
there should be a breaking change.
This commit is contained in:
Stephan Seitz 2021-12-01 20:33:18 +01:00 • committed by Kiyan
parent d6a0a26b85
commit 913b72d60d
1 changed files with 2 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -37,14 +37,11 @@ Traditional highlighting (left) vs Treesitter-based highlighting (right).
More examples can be found in [our gallery](https://github.com/nvim-treesitter/nvim-treesitter/wiki/Gallery). More examples can be found in [our gallery](https://github.com/nvim-treesitter/nvim-treesitter/wiki/Gallery).
**Warning: Treesitter and nvim-treesitter highlighting are an experimental feature of nightly versions of Neovim. **Warning: Treesitter and nvim-treesitter highlighting are an experimental feature of nightly versions of Neovim.
Please consider the experience with this plug-in as experimental until Neovim 0.6 is released! Please consider the experience with this plug-in as experimental until Tree-Sitter support in Neovim is stable!
We recommend using the nightly builds of Neovim or the latest stable version.
You can find the current roadmap [here](https://github.com/nvim-treesitter/nvim-treesitter/projects/1). 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!** 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*. 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. 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). For more detailed information on setting these up, see ["Advanced setup"](#advanced-setup).