diff --git a/README.md b/README.md index d646b7d82..c75c76a2f 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,12 @@ python3 -m pip install slither-analyzer python3 -m pip install --upgrade slither-analyzer ``` +### Using Brew + +```console +brew install slither-analyzer +``` + ### Using Git ```bash diff --git a/slither/tools/documentation/README.md b/slither/tools/documentation/README.md index 218f2e91d..367d46d1d 100644 --- a/slither/tools/documentation/README.md +++ b/slither/tools/documentation/README.md @@ -1,5 +1,5 @@ # slither-documentation -`slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documenation. +`slither-documentation` uses [codex](https://platform.openai.com) to generate natspec documentation. This tool is experimental. See [solmate documentation](https://github.com/montyly/solmate/pull/1) for an example of usage.