README

README.md

@@ -29,3 +29,37 @@ docker pull nicksherron/bashhub-server
 #### Releases 
 Static binaries for various os and architectures can be found in [releases](https://github.com/nicksherron/bashhub-server/releases).
 If your system is not listed just add an issue requesting your os and architecture.
+
+## Usage 
+```shell script
+$ bashhub-server --help
+Usage:
+   [flags]
+   [command]
+
+Available Commands:
+  help        Help about any command
+  version     Print the version number and build info
+
+Flags:
+  -a, --addr string   Ip and port to listen and serve on. (default "0.0.0.0:8080")
+      --db string     DB location (sqlite or postgres) (default "/Users/nicksherron/Library/Application Support/bashhub-server/data.db")
+  -h, --help          help for this command
+
+Use " [command] --help" for more information about a command.
+```
+
+Just run the server 
+
+```shell script
+$ bashhub-server
+```
+or on docker 
+
+```shell script
+$ docker run -d -p 8080:8080 --name bashhub-server  nicksherron/bashhub-server 
+
+```
+Then add ```export BH_HOST=localhost:8080``` (or whatever you set your bashhub-server address to) to your .zshrc or .bashrc 
+
+Thats it!