diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 232e6856..91553830 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ To contribute code changes to this project you will need to install the go distribution. * [Go](https://golang.org/doc/install) -Also, as shoutrrr utilizes go modules for vendor locking, you'll need atleast Go 1.11. +Also, as shoutrrr utilizes go modules for vendor locking, you'll need at least Go 1.11. You can check your current version of the go language as follows: ```bash ~ $ go version @@ -19,9 +19,9 @@ cd shoutrrr ## Building and testing shoutrrr is a go library and is built with go commands. The following commands assume that you are at the root level of your repo. ```bash -go build ./cmd/shoutrrr # compiles and packages an executable stand-alone client of shoutrrr +./build.sh # compiles and packages an executable stand-alone client of shoutrrr go test ./... -v # runs tests with verbose output -./shoutrrr # runs the application +./shoutrrr/shoutrrr # runs the application ``` ## Commit messages diff --git a/README.md b/README.md index 4b93cb47..5227917a 100644 --- a/README.md +++ b/README.md @@ -34,13 +34,13 @@ $ sudo snap install shoutrrr ### Using the Go CLI ```bash -$ go install github.com/containrrr/shoutrrr@latest +$ go install github.com/containrrr/shoutrrr/shoutrrr@latest ``` ### From Source ```bash -$ go build -o shoutrrr . +$ go build -o shoutrrr ./shoutrrr ``` ## Quick Start diff --git a/build.sh b/build.sh index 6dce2971..c529784f 100755 --- a/build.sh +++ b/build.sh @@ -1,3 +1,3 @@ #!/bin/sh -go build -o ./shoutrrr/shoutrrr ./shoutrrr +go build -o shoutrrr/ ./shoutrrr