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

Update README with 'go install' instructions #436

Closed
priyanshujain opened this issue Jul 11, 2023 · 2 comments · Fixed by #437
Closed

Update README with 'go install' instructions #436

priyanshujain opened this issue Jul 11, 2023 · 2 comments · Fixed by #437

Comments

@priyanshujain
Copy link
Contributor

I would like to suggest an improvement to the installation instructions in the README of the Stripe-Mock repository. Currently, the README suggests installing the package using the command 'go get', but I believe it would be more consistent and convenient to use 'go install' instead.

Here are the reasons for my suggestion:

  1. Uniformity: Many Go packages recommend using 'go install' for installation, which is the standard way of installing Go binaries.
  2. Simplicity: 'go install' downloads and installs the package in a single step, without the need for additional commands.
  3. Reduced clutter: 'go install' places the binary in the default location, which is typically in the user's $GOPATH/bin directory. This avoids adding additional dependencies to the project.

I propose updating the README with the following installation instructions:

go install github.com/stripe/stripe-mock

I believe this change would enhance the user experience and align the installation process with the Go community's conventions. Thank you for considering my suggestion.

@anniel-stripe
Copy link
Contributor

Hi @priyanshujain , very happy to take your suggestion, and thanks for providing a detailed list of reason! Do you want to open a PR to update the README? Should just be a one-line change, and that way you can get direct credit for the contribution. :)

@priyanshujain
Copy link
Contributor Author

@anniel-stripe I have raised the PR (#437).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants