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

Commit

Permalink
docs: call out ganache-cli@latest documentation loudly (#1407)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmurdoch committed Oct 27, 2021
1 parent aeecbb2 commit 0346754
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions src/packages/ganache/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
_Looking for ganache-cli v6 documentation? Check here: https://github.com/trufflesuite/ganache-cli-archive_
<h3 align="center">
⚠ 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
</h3>

---

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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": {
Expand Down

0 comments on commit 0346754

Please sign in to comment.