From d243aa2b1756540f4b743e1cb55f7e28c3f868eb Mon Sep 17 00:00:00 2001
From: Yevgeniy Firsov <firsov@tigrisdata.com>
Date: Mon, 5 Jun 2023 14:33:56 -0700
Subject: [PATCH] chore: README.md

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

diff --git a/README.md b/README.md
index 99161c8..2b1c0c5 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,27 @@
 # Tigris NoQL generation tool
 
+This tool looks up for the Tigris API calls in the source code and
+generates query filters and update mutations for the filter and update
+functions passed as parameters to the Tigris APIs.
+
+# Install
+
+```shell
+go install github.com/tigrisdata/tigrisgen@latest
+```
+
+# Setup
+
+Include the following line in one of the files in the package
+which contains Tigris API calls:
+
+```shell
+//go:generate tigrisgen
+```
+
+Now, when building you project, before calling `go build` you need to run `go generate ./...` to
+generate query filters and update mutations.
+
 # License
 
 This software is licensed under the [Apache 2.0](LICENSE).