fix: update preview

marsfoundation · Jul 23, 2024 · 1206ddc · 1206ddc
1 parent bb71aec
commit 1206ddc
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -62,7 +62,8 @@ The deployment script [TODO] in this repo contains logic for the deployer to per
 
 - **`previewDeposit`**: Estimates the number of shares minted for a given deposit amount.
 - **`previewWithdraw`**: Estimates the number of shares burned and the amount of assets withdrawn for a specified amount.
-- **`previewSwap`**: Estimates the amount of one asset received for a given amount of another asset in a swap.
+- **`previewSwapExactIn`**: Estimates the amount of `assetOut` received for a given amount of `assetIn` in a swap.
+- **`previewSwapExactIn`**: Estimates the amount of `assetIn` required to receive a given amount of `assetOut` in a swap.
 
 #### Conversion Functions