From 9ac61eae71b75b6b301594172cd5a03be01aa98e Mon Sep 17 00:00:00 2001 From: Daniela Petruzalek Date: Thu, 25 Jul 2024 14:22:07 +0100 Subject: [PATCH] update readme --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e9fd97..afa20f6 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ It is currently under development so it doesn't support a lot of information yet ## Usage +To use it, compile the code with `make build` (or `go build` if you are being wild) and run `tq` from the command line. By default `tq` will run data collection on the current directory but you can pass a package to it by using the `--pkg` flag. + ```sh % tq --help Usage of tq: @@ -60,7 +62,6 @@ By default tq will launch in iterative mode unless you pass a `--query` flag: ``` -To use it, compile the code with `make build` (or `go build` if you are being wild) and run `tq` from the command line. By default `tq` will run data collection on the current directory but you can pass a package to it by using the `--pkg` flag. To run the examples (in `sql/queriesl.sql`), clone this project and run the following command: