From 5913b3e45e07d22dcc0cd46b903b6e64e883e705 Mon Sep 17 00:00:00 2001 From: Rosco Kalis Date: Mon, 1 Aug 2022 15:40:15 +0200 Subject: [PATCH] Update README --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d71f86f..b57a02a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,24 @@ # Revoke.cash Browser Extension -In many cases, phishing websites try to make you sign an allowance while they pretend to be an NFT mint or other legitimate use cases. When these phishing scams happen, it is recommended to use Revoke.cash to mitigate the damage, but it is even better to prevent the scam in the first place. +In many cases, phishing websites try to make you sign a token allowance while they pretend to be an NFT mint or other legitimate use cases. When these phishing scams happen, it is recommended to use the Revoke.cash website to mitigate the damage, but it is even better to prevent the scam in the first place. This is where the Revoke.cash Browser Extension comes in. The extension pops up whenever you are about to sign an allowance and will inform you of the allowance details. This can help you prevent signing malicious allowances. -The Revoke.cash browser extension works with every EVM-based network such as Ethereum, Avalanche or Polygon, including chains that are not supported on the Revoke.cash website. +The Revoke.cash browser extension works with every EVM-based network such as Ethereum, Avalanche or Polygon. -## Running locally +## Development -To continuously build the application using webpack you can run `yarn dev`. This will make sure that the `dist/` directory is always up to date. From there you can import this directory into your browser (e.g. through `chrome://extensions`). +### Prerequisites + +Contributing to the Revoke.cash extension requires Node.js v16+ and Yarn. + +### Running locally + +To continuously build the application using webpack you can run `yarn dev:chrome` or `yarn dev:firefox`. This will make sure that the `dist/` directory is always up to date. From there you can import the generated directory into your browser (e.g. through `chrome://extensions`). + +### Building for publication + +To build and package the extension for publication you can run `yarn build && yarn zip`. This will generate zip files for every supported platform that can be submitted to their respective extension stores. ## Credits