From 3ac9340e5489db3126d94b9dd7fdb4dbad08d77d Mon Sep 17 00:00:00 2001
From: David Murdoch <187813+davidmurdoch@users.noreply.github.com>
Date: Mon, 18 Oct 2021 15:22:25 -0400
Subject: [PATCH 1/3] Call out ganache-cli@latest documentation loudly
---
src/packages/ganache/README.md | 20 ++++++++++++++------
1 file changed, 14 insertions(+), 6 deletions(-)
diff --git a/src/packages/ganache/README.md b/src/packages/ganache/README.md
index 44c4d39968..e3637c83cc 100644
--- a/src/packages/ganache/README.md
+++ b/src/packages/ganache/README.md
@@ -1,4 +1,6 @@
-_Looking for ganache-cli v6 documentation? Check here: https://github.com/trufflesuite/ganache-cli-archive_
+
+ ⚠ This documentation describes the alpha release of Ganache. You can find instructions to install the stable release at https://github.com/trufflesuite/ganache-cli-archive ⚠
+
---
@@ -50,16 +52,22 @@ Ganache can be used from the [command line](#command-line-use), [programmaticall
You must first install [Node.js](https://nodejs.org/) >= v10.13.0 and npm >= 6.4.1.
-To install ganache globally, run:
+To install Ganache *alpha* globally, run:
+
+```console
+$ npm install ganache@alpha --global
+```
+
+For the latest stable release of ganache-cli, run:
```console
-$ npm install ganache --global
+$ npm install ganache-cli@latest --global
```
Once installed globally, you can start ganache right from your command line:
```console
-$ ganache
+$ ganache-cli
Ganache CLI v6.12.1 (ganache-core: 2.13.1)
Available Accounts
@@ -108,13 +116,13 @@ Call Gas Limit
Listening on 127.0.0.1:8545
```
-To install Ganache into an npm project, run:
+To install Ganache alpha into an npm project, run:
```console
$ npm install ganache
```
-You can then add ganache to your package.json scripts:
+You can then add Ganache to your package.json scripts:
```json
"scripts": {
From 125de6b17c5388f4892b5cae721a43adf8930141 Mon Sep 17 00:00:00 2001
From: David Murdoch <187813+davidmurdoch@users.noreply.github.com>
Date: Mon, 18 Oct 2021 15:28:16 -0400
Subject: [PATCH 2/3] updates based on review (via slack message)
---
src/packages/ganache/README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/packages/ganache/README.md b/src/packages/ganache/README.md
index e3637c83cc..d44ff3a30b 100644
--- a/src/packages/ganache/README.md
+++ b/src/packages/ganache/README.md
@@ -1,5 +1,5 @@
- ⚠ This documentation describes the alpha release of Ganache. You can find instructions to install the stable release at https://github.com/trufflesuite/ganache-cli-archive ⚠
+ ⚠ Note: This documentation describes the alpha release of Ganache. If you are looking to install the stable version of Ganache you can find instructions at https://github.com/trufflesuite/ganache-cli-archive ⚠
---
From f2af6b3443de021bc0bcdffb853d9c4a46ad6aef Mon Sep 17 00:00:00 2001
From: David Murdoch <187813+davidmurdoch@users.noreply.github.com>
Date: Mon, 18 Oct 2021 15:28:44 -0400
Subject: [PATCH 3/3] note -> notice
---
src/packages/ganache/README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/packages/ganache/README.md b/src/packages/ganache/README.md
index d44ff3a30b..0e3fe8c779 100644
--- a/src/packages/ganache/README.md
+++ b/src/packages/ganache/README.md
@@ -1,5 +1,5 @@
- ⚠ Note: This documentation describes the alpha release of Ganache. If you are looking to install the stable version of Ganache you can find instructions at https://github.com/trufflesuite/ganache-cli-archive ⚠
+ ⚠ Notice: This documentation describes the alpha release of Ganache. If you are looking to install the stable version of Ganache you can find instructions at https://github.com/trufflesuite/ganache-cli-archive ⚠
---