update readme.md

thilllon · Oct 31, 2022 · 8d27636 · 8d27636
1 parent edce0d5
commit 8d27636
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
-# ngrv
+# ngrv
+
+Engrave build information to the build output. Set environment variables automatically.
+
+## How to use?
+
+```sh
+npx ngrv # that's it. nothing else. no need to install.
+
+# if you want to change the directory where ngrv files will be stored to './.ngrv', then
+npx ngrv create -d .ngrv
+# or
+npx ngrv c -d .ngrv
+```