trufflesuite / ganache

:warning: The Truffle Suite is being sunset. For information on ongoing support, migration options and FAQs, visit the Consensys blog. Thank you for all the support over the years.
https://consensys.io/blog/consensys-announces-the-sunset-of-truffle-and-ganache-and-new-hardhat?utm_source=github&utm_medium=referral&utm_campaign=2023_Sep_truffle-sunset-2023_announcement_
MIT License
2.62k stars 678 forks source link

docs: update README.md to clarify usage #3723

Closed emilyJLin95 closed 1 year ago

emilyJLin95 commented 2 years ago

Just clarifying how to run Ganache for usage on the CLI as well as in programmatic usage.

davidmurdoch commented 2 years ago

The section you're updating is about adding ganache to an npm project (it gets added to their package.json as a dependency).

There is already a section in the README.md about command line use that says:

Once installed globally, you can start ganache right from your command line:

$ ganache
Ganache CLI v6.12.1 (ganache-core: 2.13.1)

I welcome improvements to the readability here so it is more clear on the different ways ganache can be used.

emilyJLin95 commented 1 year ago

ah okay updated section titles

also, just wondering, is line 50 still up to date? do we support node v12

@davidmurdoch

davidmurdoch commented 1 year ago

ah okay updated section titles

also, just wondering, is line 50 still up to date? do we support node v12

@davidmurdoch

Yes, Ganache still works with v12.0.0+. This will be changing soon though.

gitpoap-bot[bot] commented 1 year ago

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2022 Ganache Contributor:

GitPOAP: 2022 Ganache Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.