From 6280b567b9218bd35a006a0a8da1aa161bc49dff Mon Sep 17 00:00:00 2001 From: nicksherron Date: Mon, 10 Feb 2020 01:35:12 -0500 Subject: [PATCH] README --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index f604a2e..befabea 100644 --- a/README.md +++ b/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! \ No newline at end of file