diff --git a/README.md b/README.md index 1e41d8a..18768ee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,41 @@ -# chipmunk +hdx +============================= -[![GoDoc](https://godoc.org/github.com/dmmcquay/chipmunk?status.svg)](https://godoc.org/github.com/dmmcquay/chipmunk) -[![Go Report Card](https://goreportcard.com/badge/github.com/dmmcquay/chipmunk)](https://goreportcard.com/report/github.com/dmmcquay/chipmunk) +Simple IP counting web service -Budget planning and logging. +Installing From Source +============================== + +Move the `hdx` directory in the root of your `$GOPATH`. Once there, you can +install by running + +```bash +$ go install hdx/... +``` + +This will yield a binary called `hdxd`. `hdxd` comes with its own usage: + + +```bash +$ hdxd run -h + +run hdxd with given options + +Usage: + app run [flags] + +Flags: + -h, --help help for run + -n, --host string hostname + -p, --port int port (default -1) +``` + +`hdxd` can be run by giving these flags values. For example: + +```bash +$ hdxd run -p 8080 +``` + +is the most basic way to run the application. + +Expects a Postgres DB with DBName 'hdx', DBUser 'dm' and running on localhost:5432 diff --git a/cmd/hdxd/main.go b/cmd/hdxd/main.go index f5bbd87..530c718 100644 --- a/cmd/hdxd/main.go +++ b/cmd/hdxd/main.go @@ -34,7 +34,7 @@ func main() { var run = &cobra.Command{ Use: "run", Short: "run command", - Long: `run chipd with given options`, + Long: `run hdxd with given options`, Run: func(cmd *cobra.Command, args []string) { config := &Config{ DBHost: "localhost",