Update README.md #3
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Additional steps for new Go users
SegFaultAX
reviewed
Nov 17, 2020
|
|
||
| ```shell | ||
| check-graphite -g graphite.example.com -m 'my.metric' -w 10 -c 100 | ||
| go-check-graphite -g graphite.example.com -m 'my.metric' -w 10 -c 100 |
Owner
There was a problem hiding this comment.
This slightly confusing the but the executable as produced by goreleaser is actually check-graphite, but when using go install it uses the default executable name which is equal to the last directory in the install path.
Author
There was a problem hiding this comment.
Oh, interesting, I wasn't aware of that caveat. It was something I ran into so I figured others might end up pinging you with the same question :)
| ## Installation | ||
|
|
||
| `go install github.com/segfaultax/go-check-graphite` | ||
| 1. Make sure you have Go installed first. If you're on a Mac, you can install |
Owner
There was a problem hiding this comment.
These steps are redundant with every other go package, but since you took the effort let me clean it up slightly. What do you think of this?
- Install Go (this project uses Go Modules, ensure you're using Go 1.11+)
- Download:
go get github.com/segfaultax/go-check-graphite - If you'd like to install it locally:
go install github.com/segfaultax/go-check-graphite
Note: When installed via go install, the executable will be named go-check-graphite.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Additional steps for new Go users