Update README.md

FilosofiaCodigo · Jan 7, 2023 · fbd8763 · fbd8763
1 parent 1aeb209
commit fbd8763
Showing 1 changed file with 23 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -2,34 +2,35 @@
 
 ![workflow](https://github.com/FilosofiaCodigo/Biblioteca/actions/workflows/unit-tests.yml/badge.svg)
 
-**A library for interoperable smart contract development**. Build smart contracts integrated to a variety of decentralized protocols.
+A library for interoperable smart contract development**. Build smart contracts integrated to a variety of decentralized protocols.
+**Integrations library for smart contracts**. Build interopable smart contracts connected to a variety of decentralized protocols.
 
 ## Contracts
 
-| Contract | Released | Has video | Unit Tests | Audit |
-|----------|----------|-----------|------------|-------|
-| Uniswap V2 Fee Token | ✔ | ❌ | ❌ | ❌ |
-| Uniswap V2 AutoSwap Token | ✔ | ❌ | ✔ | ❌ |
-| Balancer V2 Fee Token | ✔ | ❌ | ❌ | ❌ |
-| Uniswap V3 Fee Token | ✔ | ❌ | ✔ | ❌ |
-| OpenZeppelin NFT Collection | ✔| ❌ | ❌ | ❌ |
-| Azuki NFT Collection | ✔| ❌ | ❌ | ❌ |
-| Aave Interface | ❌ | ❌ | ❌ | ❌ |
-| Sudoswap Interface | ❌ | ❌ | ❌ | ❌ |
+| Origin | Contract | Released | Has video | Unit Tests | Audit |
+|-----|----------|----------|-----------|------------|-------|
+| <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/uniswap.png" width="50"/> | Uniswap V2 Fee Token | ✔ | ❌ | ❌ | ❌ |
+| <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/uniswap.png" width="50"/> | Uniswap V2 AutoSwap Token | ✔ | ❌ | ✔ | ❌ |
+| <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/balancer.png" width="50"/> | Balancer V2 Fee Token | ✔ | ❌ | ❌ | ❌ |
+| <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/uniswap.png" width="50"/> | Uniswap V3 Fee Token | ✔ | ❌ | ✔ | ❌ |
+| <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/openzeppelin.png" width="50"/> | OpenZeppelin NFT Collection | ✔| ❌ | ❌ | ❌ |
+| <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/azuki.png" width="50"/> | Azuki NFT Collection | ✔| ❌ | ❌ | ❌ |
+| | Aave Interface | ❌ | ❌ | ❌ | ❌ |
+| | Sudoswap Interface | ❌ | ❌ | ❌ | ❌ |
 
-## Keep in mind
+## 📝 Keep in mind
 
 * This contracts are based on OpenZeppelin libraries but changed `private` variables to `internal` for flexibility
 * All contracts are `Ownable`
 * All percentage numbers are 2 digit decimals (e.g. 150 percent is 1.5%)
 
-## Important!
+## ⚠️ Important!
 
 Many libraries are not audited. Use at your own risk! Also, PRs and upstream changes very welcome.
 
-## ERC20 Tokens
+## 🪙 ERC20 Tokens
 
-### Uniswap V2 Fee Token
+### Uniswap V2 Fee Token <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/uniswap.png" width="50"/>
 
 ERC20 token that takes fees on P2P, buy and sell on Uniswap V2 and transfer them to a Vault.
 
@@ -54,7 +55,7 @@ contract MyUniswapV2FeeToken is UniswapV2FeeToken
 ```
 
 
-### Uniswap V2 AutoSwap Token
+### Uniswap V2 AutoSwap Token <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/uniswap.png" width="50"/>
 
 ERC20 token that takes fees on P2P, buy and sell on Uniswap V2, converts them to Base Tokens and transfer them to a Vault.
 
@@ -79,7 +80,7 @@ contract MyUniswapV2AutoSwapToken is UniswapV2AutoSwapToken
 }
 ```
 
-### Balancer V2 Fee Token
+### Balancer V2 Fee Token <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/balancer.png" width="50"/>
 
 ERC20 token that takes fees on P2P, buy and sell on Balancer and transfer them to a Vault.
 
@@ -101,7 +102,7 @@ contract MyBalancerFeeToken is BalancerV2FeeToken
 }
 ```
 
-### Uniswap V3 Fee Token
+### Uniswap V3 Fee Token <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/uniswap.png" width="50"/>
 
 ERC20 token that takes fees on P2P, and buy on Uniswap V3 and transfer them to a Vault.
 
@@ -125,9 +126,9 @@ contract MyUniswapV3FeeToken is UniswapV3FeeToken
 }
 ```
 
-## NFT Collections
+## 🖼️ NFT Collections
 
-### OpenZeppelin NFT Collection
+### OpenZeppelin NFT Collection <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/openzeppelin.png" width="50"/>
 
 NFT collection with a mint price and max supply. Uses OpenZeppelin library wich is more adopted and save transfer gas fees compared to Azuki's ERC721a.
 
@@ -149,7 +150,7 @@ contract MyOpenZeppelinNFTCollection is OpenZeppelinNFTCollection
 }
 ```
 
-### Azuki ERC721a NFT Collection
+### Azuki ERC721a NFT Collection <img src="https://raw.githubusercontent.com/FilosofiaCodigo/Biblioteca/master/img/icons/azuki.png" width="50"/>
 
 NFT collection with a mint price and max supply. Uses ERC721a library wich is more newer and save batch mint gas fees compared to OpenZeppelin's ERC721 implementation.
 
@@ -169,4 +170,4 @@ contract MyERC721aCollection is ERC721aCollection
     {
     }
 }
-```
+```