aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f7da60d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# zgjq
+
+Zig implementation of [jq](https://jqlang.org/).
+
+
+## Build
+
+### Requirements
+
+- zig 0.15.x
+- [just](https://github.com/casey/just)
+
+### Steps
+
+```
+$ just build
+```
+
+
+## Test
+
+```
+$ just test
+```
+
+
+## License
+
+See [LICENSE.md](./LICENSE.md).