Added README.md

mrusme · Dec 15, 2022 · 366dd9c · 366dd9c
1 parent 1e04353
commit 366dd9c
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+xbscli
+------
+
+A command line interface for [xbsapi](https://github.com/mrusme/xbsapi) as well 
+as the official [xBrowserSync](https://github.com/xbrowsersync/api) API.
+
+
+## Build
+
+```sh
+go build .
+```
+
+## Run
+
+```sh
+xbscli \
+  -s "https://xbsapi.myserver.com/api/v1" \
+  -i $(pass show xbs/id) \
+  -p $(pass show xbs/password) \
+  -f pretty
+```
+
+