Skip to content

Commit

Permalink
docs: fix outdated documentation (#407)
Browse files Browse the repository at this point in the history
  • Loading branch information
favonia committed Nov 5, 2023
1 parent f4e1c7c commit 3428e5e
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion build.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/bin/sh

go build -o ./shoutrrr/shoutrrr ./shoutrrr
go build -o shoutrrr/ ./shoutrrr

0 comments on commit 3428e5e

Please sign in to comment.