From 092fec85a05edc324504d5d78905048a0c8731e9 Mon Sep 17 00:00:00 2001
From: Preston Baxter <preston@preston-baxter.com>
Date: Wed, 24 Jan 2024 08:51:43 -0600
Subject: [PATCH] Add readme

---
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..16966dc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# Tree Sitter Logstash
+
+This is an implementation of the treetop logstash grammar for tree-sitter.
+
+## Notes
+
+- While I tried to stick as close to the original grammar as possible in hopes of cloneing "bug for bug", some changes have been made. I see them as optimizations. Only time will tell.
+- The parser is complete, however I have some work to do on highlighting the syntax better
+- nvim-treesitter expects a unqiue-ish filename, so unlike the logstash standard, this project expects logstash pipelines to have the .logastash file extension
+
+## Neovim
+
+`nvim-treesitter` has great [instructions](https://github.com/nvim-treesitter/nvim-treesitter?tab=readme-ov-file#adding-parsers). Below is a walkthrough of their intrsuctions, but focused on tree-sitter-logstash
+
+First clone the repo into a directory that can be referenced by neovim
+
+```bash
+mkdir -p ~/some/path
+cd ~/some/path
+git clone https://git.preston-baxter.com/Preston_PLB/tree-sitter-logstash.git
+```
+
+Add this to wherever you configure your nvim. I would recomend placing this where you load `nvim-treesitter`. In your lazy config for example.
+Creating a file in the `after/` direcrtory is also fine.
+
+```lua
+    local parser_config = require "nvim-treesitter.parsers".get_parser_configs()
+    parser_config.logstash = {
+      install_info = {
+        url = "~/some/path/tree-sitter-logstash",
+        files = {"src/parser.c"}, -- note that some parsers also require src/scanner.c or src/scanner.cc
+        branch = "master",
+      },
+    }
+
+    vim.filetype.add({
+        extension = {
+            logstash = "logstash"
+        }
+    })
+    vim.treesitter.language.register("logstash", "logstash")
+```
+
+The block above tells nvim-treesitter where to find the logstash parser, defines the logstash file type, and registers that filetype to a treesitter parser
+
+
+
+In vim now run
+```
+:TSInstall logstah
+```
+
+This will load the logstash parser into neovim. Now you need to link the syntax highlighting file to a place where neovim can find it.(See [this](https://github.com/nvim-treesitter/nvim-treesitter?tab=readme-ov-file#adding-parsers) for why)
+
+```
+mkdir -p ~/.config/nvim/queries/logstash
+ln -s ~/some/path/queries/highlights.scm ~/.config/nvim/queries/logstash/highlights.scm
+```
+
+`~/.config/nvim/queries/logstash/` can be replaced with any `queries/logstash` path in a nvim runtime directory
+
+
+Now that all that is done. Load up neovim and open a logstash file