Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mgnfy-view committed Apr 23, 2024
1 parent 7c69502 commit b12b435
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ A thunder swap pool factory is deployed on-chain, and users can interact with it

Both normal swaps and flash swaps take place using the `ThunderSwapPool::flashSwapExactInput()` and `ThunderSwapPool::flashSwapExactOutput()` functions. In a normal swap, the `receiver` address is the user's wallet address; however, in a flash swap, a user sets the `receiver` address as the contract's address (which is `IThunderSwapReceiver` interface compliant). The contract that receives the token loan has to ensure that enough tokens are approved to the `ThunderSwapPool` when the control returns to it and the loan is paid back (along with fees). With flash swaps, contracts can also activate hooks before and after a swap to fine tune their swapping strategy.

Thunder Swap is marching towards a community-driven future with the introduction of the $THUD token, which is the key utility and governance token in the Thunder Swap ecosystem. Currently, the only way to obtain $THUD is via an airdrop conducted by the protocol team to reward loyal and regular users of the protocol.
Thunder Swap is marching towards a community-driven future with the introduction of the $THUD token, which is the key utility and governance token in the Thunder Swap ecosystem. Currently, the only way to obtain $THUD is via an airdrop conducted by the protocol team to reward loyal and regular users of the protocol. $THUD can be used to partake in governance, allowing the community to support more tokens on the exchange.

### Built With

Expand Down Expand Up @@ -119,13 +119,17 @@ That's it, you are good to go now!
- [x] Thunder Swap Core
- [x] Thunder Swap $THUD token
- [x] Thunder Swap Airdrop Manager
- [x] Thunder Swap Governance
- [x] Testing
- [x] Unit testing
- [x] Pool deployment tests
- [x] Liquidity tests
- [x] Flash swap tests
- [x] Airdrop tests
- [x] Governance tests
- [x] Miscellaneous tests
- [x] Write a deployment script
- [x] Write docs and README.md

See the [open issues](https://github.com/mgnfy-view/thunder-swap/issues) for a full list of proposed features (and known issues).

Expand Down

0 comments on commit b12b435

Please sign in to comment.