From 7ad7d6c69607f90a3eb6042bcb4f03498868bba5 Mon Sep 17 00:00:00 2001
From: Gonzalo Larumbe <gonzalomlarumbe@gmail.com>
Date: Thu, 29 Aug 2024 17:42:17 +0200
Subject: [PATCH] Update README.md

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 9f7d76b5..f078ee4d 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,22 @@
 
 Full SystemVerilog IEEE 1800-2023 grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter).
 
+# Differences with [tree-sitter-verilog](https://github.com/tree-sitter/tree-sitter-verilog)
+
+## Pros ##
+- Full implementation of the latest SystemVerilog standard (IEEE 1800-2023)
+- Robust and reliable
+- Actively maintained
+- Thoroughly tested (~2000 tests, including the whole UVM 2.0 and some open source projects)
+- Implements node fields
+- Supports parsing of code snippets (e.g., always block outside of a module)
+- Basic preprocessing capabilities
+- Currently used on Emacs `verilog-ts-mode` and `nvim systemverilog` plugin
+
+## Cons
+- Generated parser is double the size
+  - Generation of the compiled grammar takes longer (this only needs to be done once)
+
 ## References
 
 - https://en.wikipedia.org/wiki/Verilog