readme update explain flags and add license

speier · Nov 24, 2020 · cdffe54 · cdffe54
1 parent b4f5828
commit cdffe54
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-VERSION=v0.1.0
+VERSION=v0.1.1
 
 release:
 	@git tag -a ${VERSION} -m "Release ${VERSION}" && git push origin ${VERSION}

diff --git a/README.md b/README.md
@@ -42,3 +42,23 @@ METHOD(URL, [headers], [payload])
 `[headers]`: optional
 
 `[payload]`: optional
+
+## CLI
+
+The following flags are available:
+
+`-f`: filename
+
+`-s`: set param
+
+For example:
+
+```sh
+$ hrun -f foo.js -s a=1 b=2
+```
+
+Filename `-f` is required, `-s` is optional to set key value params, these params alongside the host environment variables will be available for the script on the `env` object.
+
+## License
+
+[MIT](LICENSE)