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 package installation guidelines to README.md #197

Closed
luigimorel opened this issue Apr 25, 2022 · 4 comments · Fixed by #204
Closed

Add package installation guidelines to README.md #197

luigimorel opened this issue Apr 25, 2022 · 4 comments · Fixed by #204

Comments

@luigimorel
Copy link
Contributor

Hey,
I'd like to add the package's installation guidelines to the README file.
This would make it easier for the users to install the package in their projects by simply copying and pasting the command to their terminals.

Could this issue be assigned to me?

Let me know what you think of the above.

@mfridman
Copy link
Member

Hey there, do you mean something like go get github.com/golang-jwt/jwt/v4@latest or the command line tool?

https://github.com/golang-jwt/jwt/tree/main/cmd/jwt#jwt-command-line-tool

@luigimorel
Copy link
Contributor Author

hey @mfridman,
yes, that's what i mean.

is it vague? would love to get your opinion.

@mfridman
Copy link
Member

mfridman commented May 6, 2022

If it helps users, even those new to Go, then it seems reasonable. Typically there would be an "Install" or "Installation" section in the readme with a command such as:

go get github.com/golang-jwt/jwt/v4@latest

And maybe a reference to the Go tooling installation: https://go.dev/doc/install#testing

@luigimorel
Copy link
Contributor Author

Great, will send a PR.

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 a pull request may close this issue.

2 participants