diff --git a/README.md b/README.md index 116e7fbe..c6c79a7e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@ # Token Lists -Automativally generate Token Lists +Automatically generate Token Lists + +## How to add an image to the CoW Swap default token list + +In order to add a new token to the CoW Swap default token list follow these steps + +- Find an icon with reasonable quality/size (256px, <100kB). +- Add the icon to `src/public/images//
.png` [^1] +- Upload the image to Pinata (login in 1Password) +- Create a new entry in `src/public/CowSwap.json` containing token address, symbol, etc. (**use IPFS link for icon!**) +- Make sure you bump the version using [SemVersions](https://github.com/Uniswap/token-lists#semantic-versioning) +- Create a PR with these changes + +[^1]: To resize/convert your image [ImageMagick](https://formulae.brew.sh/formula/imagemagick) installed you can simply run `convert ~/Downloads/img.png -resize 256 src/public/images//
.png` + +## Setup ```bash # Install dependencies