From 29e8a815a9b16d36e4021ed9eedc5615cda51cba Mon Sep 17 00:00:00 2001 From: adam Date: Mon, 16 Dec 2024 15:46:28 -0500 Subject: [PATCH] docs: readme deployment instructions --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 35394a13..f266bd57 100644 --- a/README.md +++ b/README.md @@ -69,10 +69,12 @@ forge test -vvv ### Deployment -A deployment script can be found in the `scripts/` folder +Deployment scripts can be found in the `scripts/` folder, and depend on reading parameters from your local environment or from `.env`. A sample for the required fields can be found at `.env.example`. Note that some have specific foundry profiles needed for deployment. + +You will also need provide a wallet to use for deployment. Available options can be found [here](https://book.getfoundry.sh/reference/forge/forge-script#wallet-options---raw). ```bash -forge script script/Deploy.s.sol --rpc-url $RPC_URL --broadcast +FOUNDRY_PROFILE= forge script script/.s.sol --rpc-url $RPC_URL --broadcast ``` ## Features overview @@ -94,7 +96,7 @@ Certain applications such as Permit2 or Cowswap use the ERC-1271 contract signat #### Upgradeability -When modular accounts are created from the factory, an ERC-1967 proxy contract is deployed. Users can update the implementation their proxy points to to choose which smart account implementations to use. Modular Account v2 adheres to the ERC-7201 namespaced storage standard to prevent storage collisions when updating between different implementations. +When modular accounts are created from the factory, an ERC-1967 proxy contract is deployed. Users can update the implementation their proxy points to to choose which smart account implementations to use. Modular Account adheres to the ERC-7201 namespaced storage standard to prevent storage collisions when updating between different implementations. ### Customizing your Modular Account