Updated README

README.md

@@ -1,66 +1,13 @@
-## Foundry
+# Uniswap Hooks - Donation
 
-**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
+This is a Uniswap Hooks project that allows a Uniswap user to donate away a percentage of their currency when swapping tokens.
 
-Foundry consists of:
+It performs this by hooking the afterSwap function and looking at the swap parameters in order to figure out how much to give away.
 
--   **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
--   **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
--   **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
--   **Chisel**: Fast, utilitarian, and verbose solidity REPL.
+There can only be one recipient for each user. There is no upper cap for how much a user can give away.
 
-## Documentation
 
-https://book.getfoundry.sh/
+Chee-Wee, Chua  
+12 Sep 2024.
 
-## Usage
 
-### Build
-
-```shell
-$ forge build
-```
-
-### Test
-
-```shell
-$ forge test
-```
-
-### Format
-
-```shell
-$ forge fmt
-```
-
-### Gas Snapshots
-
-```shell
-$ forge snapshot
-```
-
-### Anvil
-
-```shell
-$ anvil
-```
-
-### Deploy
-
-```shell
-$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
-```
-
-### Cast
-
-```shell
-$ cast <subcommand>
-```
-
-### Help
-
-```shell
-$ forge --help
-$ anvil --help
-$ cast --help
-```