From 117fadda9d697b3cb2a9de2ccf45d9e6230c1638 Mon Sep 17 00:00:00 2001 From: Dylan DesRosier Date: Mon, 26 Jun 2023 20:27:11 +0100 Subject: [PATCH] README --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 992bd4d..8e3d049 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,27 @@ -# Foundry template +

+ + PoolTogether Brand + +

-Template to kickstart a Foundry project. +# PoolTogether V5 Vault -## Getting started +[![Code Coverage](https://github.com/pooltogether/v5-vault/actions/workflows/coverage.yml/badge.svg)](https://github.com/pooltogether/v5-vault/actions/workflows/coverage.yml) +[![built-with openzeppelin](https://img.shields.io/badge/built%20with-OpenZeppelin-3677FF)](https://docs.openzeppelin.com/) +[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html) -The easiest way to get started is by clicking the [Use this template](https://github.com/pooltogether/foundry-template/generate) button at the top right of this page. +Have questions or want the latest news? +
Join the PoolTogether Discord or follow us on Twitter: -If you prefer to go the CLI way: +[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://pooltogether.com/discord) +[![Twitter](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/PoolTogether_) -``` -forge init my-project --template https://github.com/pooltogether/foundry-template -``` +## Overview + +In PoolTogether V5 deposits are held in Vaults. Vaults are [ERC4626](https://eips.ethereum.org/EIPS/eip-4626) compatible. Vaults are the entry point for users interacting with the PoolTogether protocol. Users deposit an underlying asset (i.e. USDC) in this contract which is then funnelled to a yield source and in exchange users receive an ERC20 token representing their share of deposits in the vault. + +- Balances are stored in a TWAB Controller. +- Yield is forwarded to the Liquidator to be sold. ## Development @@ -80,6 +91,10 @@ npm run format npm run hint ``` +### Tests + +Test names including `SLOW` will be skipped on default test runs and need to be explicitly run. + ### CI A default Github Actions workflow is setup to execute on push and pull request.