Skip to content

Add README instructions on how to add a new entry #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 27, 2023
Merged

Add README instructions on how to add a new entry #13

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a7fc2c
Add README instructions on how to add a new entry
fleupold Dec 15, 2022
2998da2
instructions for the convert command
fleupold Dec 15, 2022
a800b35
comments
fleupold Dec 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/<chainId>/<address>.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/<chainId>/<address>.png`
Copy link
Contributor

@anxolin anxolin Dec 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this optimize like https://tinypng.com do?
cc/ @fairlighteth


## Setup

```bash
# Install dependencies
Expand Down