From 015aeb0b0e7a6272fe05c4b43c9ec378d164d629 Mon Sep 17 00:00:00 2001
From: Pablo Veyrat <50438397+sogipec@users.noreply.github.com>
Date: Tue, 19 Sep 2023 20:13:44 +0200
Subject: [PATCH] readme to add a token (#101)

* readme to add a token

* update readme
---
 README.md | 33 +++++++++++++++++++++++++++------
 1 file changed, 27 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 7ae650d..15499a7 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,35 @@
-# Angle Protocol ERC20 List
+# Angle ERC20 List
 
 [![Styled With Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)
 
+This repo contains a list of ERC20 tokens for which Angle-related front-end applications like [Merkl](https://merkl.angle.money) or [Angle Protocol app](https://app.angle.money) can display logos and essential information.
+
+## Add a token to the list
+
+All tokens are listed in `ERC20_LIST.json`.
+
+To add a token to the token list:
+
+- Add in `src/assets/tokens` a svg for the token logo with as a name for the file: `tokenSymbol.svg` (e.g for CRV: `CRV.svg`)
+- Update the `ERC20_LIST.json` file with the token info in the place of the json file that corresponds to the chain on which this token exists:
+  - Make sure that the token address is checksummed
+  - Let the `hasPermit` and `useInSwap` options to false
+  - You can use the following model and replace with the information relevant to the token:
+  ```
+      "0x0E09FaBB73Bd3Ade0a17ECC321fD13a19e81cE82": {
+        "address": "0x0E09FaBB73Bd3Ade0a17ECC321fD13a19e81cE82",
+        "name": "PancakeSwap Token",
+        "decimals": 18,
+        "symbol": "CAKE",
+        "hasPermit": false,
+        "useInSwap": false,
+        "logoURI": "https://raw.githubusercontent.com/AngleProtocol/angle-token-list/main/src/assets/tokens/cake.svg"
+      }
+  ```
+
 ## `.json` Token List
 
-All tokens are listed in `ERC20_LIST.json` and should be typed as follows:
+The type for the tokens in the list is exactly as follows:
 
 ```
 interface TokenInfo {
@@ -21,7 +46,3 @@ interface TokenInfo {
   readonly description?: string;
 }
 ```
-
-## [WIP] Angle ERC20 list
-
-Create npm package to handle Angle ERC20 list accross different chains.