robertkrimen / godocdown

Format package documentation (godoc) as GitHub friendly Markdown
526 stars 56 forks source link

Update README: Change go get to go install for Go 1.16+ compatibility #20

Open papack opened 2 weeks ago

papack commented 2 weeks ago

This PR updates the installation instructions in the README to reflect the changes introduced in Go 1.16. The current go get command no longer installs the binary when using the module mode, which is now the default for Go.

The proposed change uses go install:

go install github.com/robertkrimen/godocdown/godocdown@latest

This will ensure that the binary is correctly installed to GOBIN (or GOPATH/bin if GOBIN is not set).

Why this change is necessary: