Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

docs: update README.md to clarify usage #3723

Merged
merged 1 commit into from
Nov 8, 2022
Merged

Conversation

emilyJLin95
Copy link
Contributor

@emilyJLin95 emilyJLin95 commented Sep 26, 2022

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

@davidmurdoch
Copy link
Member

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 emilyJLin95 force-pushed the update-ganache-readme branch 2 times, most recently from 79e3021 to 83ef946 Compare November 8, 2022 18:13
Make it clearer that we are running ganache inside npm
@emilyJLin95
Copy link
Contributor Author

ah okay updated section titles

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

@davidmurdoch

@davidmurdoch
Copy link
Member

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.

Copy link
Contributor

@eggplantzzz eggplantzzz left a comment

Choose a reason for hiding this comment

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

I like

@davidmurdoch davidmurdoch changed the title Update README.md docs: update README.md to clarify usage Nov 8, 2022
@davidmurdoch davidmurdoch merged commit a18a0f1 into develop Nov 8, 2022
@davidmurdoch davidmurdoch deleted the update-ganache-readme branch November 8, 2022 19:43
@gitpoap-bot
Copy link

gitpoap-bot bot commented Nov 8, 2022

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants