Readme changes

ScopeLift · Oct 26, 2023 · 3c555c0 · 3c555c0
1 parent 9c50cba
commit 3c555c0
Showing 1 changed file with 5 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,14 @@
 # Flexible Voting Clients 
 
-[Flexible Voting](https://github.com/ScopeLift/flexible-voting) is an extension to the widely used OpenZeppelin DAO Governor that enables novel voting patterns for delegates. Clients are contracts that leverage Flexible Voting to allow they these novel voting patterns, such as:
+[Flexible Voting](https://github.com/ScopeLift/flexible-voting) is an extension to the widely used [OpenZeppelin Governor](https://docs.openzeppelin.com/contracts/4.x/api/governance#Governor) that enables novel voting patterns for delegates. Clients are contracts that leverage Flexible Voting to allow they these novel voting patterns, such as:
 
 
   - Voting with tokens while earning yield in DeFi
   - Voting with tokens bridged to L2
   - Shielded voting (i.e. secret/private voting)
   - Cheaper subsidized signature based voting
-  - Better voting options with tokens held by custodians
 
-Flexible Voting Clients contains existing clients and the tools to build new clients.
+The Flexible Voting Clients repo contains existing clients and the necessary tools to build new clients.
 
 #### Getting started
 
@@ -23,7 +22,7 @@ cd flexible-voting-clients
 Copy the `.env.template` file and populate it with values
 
 ```bash
-cp sample .env
+cp .env.template .env
 # Open the .env file and add your values
 ```
 
@@ -37,9 +36,9 @@ forge test
 
 | Name               | Description                                                                                                                                                                                    | Contract                                           |
 |--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|
-| Aave Atoken Client | An extension of Aave V3's AToken contract which makes it possible for AToken  holders to still vote on governance proposals                                                                    | [ATokenFlexVoting](./src/ATokenFlexVoting.sol)     |
+| Aave AToken Client | An extension of Aave V3's AToken contract which makes it possible for AToken holders to still vote on governance proposals                                                                    | [ATokenFlexVoting](./src/ATokenFlexVoting.sol)     |
 | Comet Client       | This is an extension of Compound V3's Comet contract which makes it possible for Comet token holders to still vote on governance proposals.                                                    | [CometFlexVotingClient](./src/CometFlexVoting.sol) |
-| Flex Voting Client |This is an abstract contract to make it easy to build clients for governance systems that are "flexible voting" governors. | [FlexVotingClient](./src/FlexVotingClient.sol) |
+| Flex Voting Client |This is an abstract contract to make it easy to build clients for governance systems that are "flexible voting" governors. The above clients inherit from this contract. | [FlexVotingClient](./src/FlexVotingClient.sol) |
 
 ## License