diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..39ea591 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# tree-sitter-wmap + +This is a tree-sitter parser for the `wmap` notation for wardley maps with a +built-in neovim plugin if you use `nvim-treesitter`. + +Learn more about the notation at the [map website][map]. + +## Neovim plugin + +If you use `nvim-treesitter`, you can also include this as a plugin and it will +configure the file types and highlights. + +``` +require('lazy').setup({ + ... + 'nvim-treesitter/nvim-treesitter', + 'https://git.sr.ht/~rbdr/tree-sitter-api-notation' + ... +} +``` + +[map]: https://map.tranquil.systems |