Skip to content

Commit

Permalink
update notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Stamp9 committed Oct 7, 2024
1 parent 607403f commit d782fb1
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ cd dirty-waters
```
python3 -m venv venv
source venv/bin/activate
cd tool
pip install -r requirements.txt
```
3. Set up the GitHub API token:
Expand Down Expand Up @@ -64,15 +65,16 @@ python main.py -w <wallet_repo_name> -v <release_version_old> -s -pm <package_ma
#### Example usage:
1. One version analysis:
```
python3 main.py -w metamask/metamask-extension -v 1.11.0 -s -pm yarn-berry
python3 main.py -w MetaMask/metamask-extension -v v11.11.0 -s -pm yarn-berry
```

2. Differential analysis:
```
python3 main.py -w metamask/metamask-extension -v 1.11.0 -vn 1.12.0 -s -d -pm yarn-berry
python3 main.py -w MetaMask/metamask-extension -v v11.11.0 -vn v11.12.0 -s -d -pm yarn-berry
```

Notes:
- `-v` should be the version of GitHub release, e.g. for [this release](https://github.com/MetaMask/metamask-extension/releases/tag/v11.1.0), the value should be `v11.11.0`, not `Version 11.11.0`.
- The `-s` flag is required for all analyses.
- When using `-d` for differential analysis, both `-v` and `-vn` must be specified.

Expand Down

0 comments on commit d782fb1

Please sign in to comment.