update readme

Signed-off-by: Derek McQuay <derekmcquay@gmail.com>
This commit is contained in:
Derek McQuay 2018-04-10 19:44:35 -07:00
parent 59af8fc84f
commit 2dc80f928b
No known key found for this signature in database
GPG Key ID: 50CA472F40A5AFED
2 changed files with 40 additions and 5 deletions

View File

@ -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

View File

@ -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",