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

Updated README #177

Merged
merged 3 commits into from
Jun 1, 2021
Merged

Updated README #177

merged 3 commits into from
Jun 1, 2021

Conversation

albertogeniola
Copy link
Contributor

Added GO installation instructions

Added GO installation instructions
Aligned Mosquitto version to 1.6.10
@iegomez
Copy link
Owner

iegomez commented May 28, 2021

Hey, @albertogeniola! Thanks for your contribution.

I think if we want to bump up the versions we could use Mosquito 2.x.y. Also, the plugin doesn't depend on Go's 1.13 version, I'm pretty sure it runs fine with latest, though I haven't tried in a couple of weeks.

@albertogeniola
Copy link
Contributor Author

Hey, @albertogeniola! Thanks for your contribution.

I think if we want to bump up the versions we could use Mosquito 2.x.y. Also, the plugin doesn't depend on Go's 1.13 version, I'm pretty sure it runs fine with latest, though I haven't tried in a couple of weeks.

Hi @iegomez ,
yeah, 1.13 is not mandatory. I've just picked that one as versions lower than that failed (due to missing TLS1.3). Which version would you advice to pin? I can test it and report back to you.
Also, I'm currently using mosquitto 2.0.9, so I agree we can bump that as well.

@iegomez
Copy link
Owner

iegomez commented May 30, 2021

@albertogeniola maybe instead of pinning a version in instructions, you can just link to Go's download page: https://golang.org/dl/

@albertogeniola
Copy link
Contributor Author

In my opinion (and experience), we should at least specify or pin a minimum GO version. The reason why I started this PR is that: the installation instructions tells you to install go and so I did. However, after building problems, I realized that the go version was not recent enough: as soon as I updated go to 1.13, I was able to build.

If you agree, I'd add some comments to the README to make users print the Go version and tell to update to minimum version 1.13 (via Go download website) if the installed version is older than that. Would this work for you?

Updated Go update and installation instructions
Copy link
Contributor Author

@albertogeniola albertogeniola left a comment

Choose a reason for hiding this comment

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

@iegomez : I've updated the instructions to point to the official Go download page. I've also bumped up the Go installed version to 1.16.

@iegomez
Copy link
Owner

iegomez commented May 31, 2021

@albertogeniola My point was more about just linking to the official page instead of setting a specific version in the README, I absolutely agree about stating what's the minimum supported version.

@iegomez iegomez merged commit 2d26443 into iegomez:master Jun 1, 2021
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.

None yet

2 participants