Skip to content

Commit 3a9b0fa

Browse files
authored
add quick install and link to installation intrs. (#465)
* add quick install and link to installation intrs.
1 parent a6d14ca commit 3a9b0fa

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
`medusa` is a cross-platform [go-ethereum](https://github.com/ethereum/go-ethereum/)-based smart contract fuzzer inspired by [Echidna](https://github.com/crytic/echidna).
44
It provides parallelized fuzz testing of smart contracts through CLI, or its Go API that allows custom user-extended testing methodology.
55

6-
**Disclaimer**: Please note that `medusa` is an **experimental** smart contract fuzzer. Currently, it should _not_ be adopted into production systems. We intend for `medusa` to reach the same capabilities and maturity that Echidna has. Until then, be careful using `medusa` as your primary smart contract fuzz testing solution. Additionally, please be aware that the Go-level testing API is still **under development** and is subject to breaking changes.
6+
**Disclaimer**: The Go-level testing API is still **under development** and is subject to breaking changes.
77

88
## Features
99

@@ -29,6 +29,23 @@ cd docs
2929
mdbook serve
3030
```
3131

32+
## Install
33+
34+
MacOS users can install the latest release of `medusa` using Homebrew:
35+
36+
```shell
37+
38+
brew install medusa
39+
```
40+
41+
The master branch can be installed using the following command:
42+
43+
```shell
44+
brew install --HEAD medusa
45+
```
46+
47+
For more information on building from source or obtaining binaries for Windows and Linux, please refer to the [installation guide](./docs/src/getting_started/installation.md).
48+
3249
## Contributing
3350

3451
For information about how to contribute to this project, check out the [CONTRIBUTING](./CONTRIBUTING.md) guidelines.

0 commit comments

Comments
 (0)