Merge pull request #18 from euler-xyz/readme

Readme
euler-xyz · Apr 9, 2024 · 7a49ea3 · 7a49ea3
2 parents 0ad2ebb + 2c282a8
commit 7a49ea3
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 14 deletions.
diff --git a/README.MD b/README.MD
@@ -1,6 +1,8 @@
 # Fee Flow
 
-Generic contract for auctioning multiple tokens in a single auction.
+Efficient, decentralised and MEV resistant mechanism to convert fee assets to a single token. Powered by a continuous auto-adjusting Dutch auction mechanism.
+
+For more information, refer to the [whitepaper](docs/whitepaper.md)
 
 ## How to run
 
@@ -11,4 +13,15 @@ forge build
 forge test
 # generate coverage
 forge coverage --report lcov && genhtml lcov.info --branch-coverage --output-dir coverage
-```
+```
+
+## Security
+
+Fee Flow has been audited by Zellic, Ottersec and Team Omega. You can find the audit reports [here](audits/).
+
+**No warranties are provided** and **no liability will be accepted for any loss** incurred through the use of this codebase.
+
+
+## License
+
+Licensed under the [GPL-2.0-or-later](LICENSE) license.
diff --git a/script/Counter.s.sol b/script/Counter.s.sol