From 3a7fc2cf12ab62c1fe67aebb5e34bea6f0d7c383 Mon Sep 17 00:00:00 2001 From: Felix Leupold Date: Thu, 15 Dec 2022 10:19:29 +0100 Subject: [PATCH 1/3] Add README instructions on how to add a new entry --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 116e7fbe..fa16c377 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # 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` +- 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 +- Create a PR with these changes + +## Setup ```bash # Install dependencies From 2998da2d35c60065b5058ca4efa723f9972a0045 Mon Sep 17 00:00:00 2001 From: Felix Leupold Date: Thu, 15 Dec 2022 20:38:21 +0100 Subject: [PATCH 2/3] instructions for the convert command --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fa16c377..c9529448 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,15 @@ Automatically generate Token Lists 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` +- 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 - 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 From a800b350c55985a771ba9e7fb748aa494adbbbc8 Mon Sep 17 00:00:00 2001 From: Felix Leupold Date: Fri, 16 Dec 2022 15:29:58 +0100 Subject: [PATCH 3/3] comments --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c9529448..c6c79a7e 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ Automatically generate Token Lists 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). +- 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 +- 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`