Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note to README on using go get and Go modules #481

Merged
merged 2 commits into from
Jun 7, 2019

Conversation

wallyqs
Copy link
Member

@wallyqs wallyqs commented Jun 7, 2019

go get needs special handling with trailing slashes when using Go modules so adding to the readme (more info at #478)

@coveralls
Copy link

coveralls commented Jun 7, 2019

Coverage Status

Coverage increased (+0.2%) to 92.514% when pulling 9251745 on go-get-go-modules into 7b479cd on master.

Copy link
Member

@derekcollison derekcollison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor comments.

README.md Outdated
@@ -15,6 +15,17 @@ go get github.com/nats-io/nats.go/
go get github.com/nats-io/nats-server
```

When using Go modules (`GO111MODULE=on`):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Go 1.12 makes them on by default I think, so maybe say "When using or transitioning to Go Modules support, ..."

go get github.com/nats-io/nats.go/@v1.8.1

# Server
go get github.com/nats-io/nats-server/v2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They may need or want the 1.x version so we should show an option for getting that version too, but comment it out and give a comment.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, ok made the updates

Copy link
Member

@derekcollison derekcollison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@derekcollison derekcollison merged commit 1133a83 into master Jun 7, 2019
@derekcollison derekcollison deleted the go-get-go-modules branch July 11, 2019 04:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants