From 7f86b2cd95488491d780500f26024776fbfb51e3 Mon Sep 17 00:00:00 2001 From: John X <41551283+johnx25bd@users.noreply.github.com> Date: Sat, 25 Nov 2023 20:39:49 +0000 Subject: [PATCH] Update README.md README edits --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 16367c1..1e4d2f8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # Offset Helper -This contract has the purpose to simplify the carbon offsetting process. +This contract simplifies the carbon offsetting process on Toucan. -What it does in more exact terms is it abstracts the process of retiring TCO2, which normally looks like so: +More specifically, the Offset Helper abstracts the process of using a stablecoin to acquire and retire TCO2. This process normally looks like: -- user exchanges USDC for BCT/NCT tokens at one of the DEXs (Uniswap, Sushiswap, etc. depending on network) -- user interacts with the BCT/NCT token contract to redeem the tokens for TCO2 +- user exchanges USDC (a stablecoin) for carbon reference tokens like BCT or NCT using a DEX like Uniswap, Sushiswap, etc. (depending on network) +- user interacts with the BCT/NCT pool token contract to redeem TCO2 tokens from within the pool - user interacts with the TCO2 token contract to retire the TCO2 +You can see this process explained in more depth in our [docs](https://docs.toucan.earth/toucan/introduction/overview). + With the OffsetHelper contract, the user only needs to interact with the OffsetHelper contract, which will take care of the rest in a single transaction. ## Deployments @@ -22,14 +24,14 @@ See [./docs/OffsetHelper.md](./docs/OffsetHelper.md) for detailed documentation. ### Development -## Preqrequisites +## Prerequisites 1. Install the required packages: ``` yarn ``` 2. Copy `.env.example` to `.env` and modify values of the required environment variables: - 1. `POLYGON_URL`/`MUMBAI_URL` to specify custom RPC endpoints for Polygon Mainnet, respectively, the Mumbai Testnet. + 1. `POLYGON_URL`/`MUMBAI_URL` to specify your preferred RPC endpoints for Polygon Mainnet and the Mumbai Testnet. 2. `PRIVATE_KEY` and `POLYGONSCAN_KEY` in order to deploy contract and publish source code on [polygonscan](https://polygonscan.com). ## Commands