Skip to content

Updated README file with better instructions #2049

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,32 @@
[![Tests](https://github.com/Uniswap/token-lists/workflows/Tests/badge.svg)](https://github.com/Uniswap/default-token-list/actions?query=workflow%3ATests)
[![npm](https://img.shields.io/npm/v/@uniswap/default-token-list)](https://unpkg.com/@uniswap/default-token-list@latest/)

This NPM module and GitHub repo contains the default token list used in the Uniswap interface.
This repository contains the **default token list** used by the Uniswap interface.
It provides a standard way to share and update token metadata across different applications.

## Adding a token
---

To request that we add a token to the list,
[file an issue](https://github.com/Uniswap/default-token-list/issues/new?assignees=&labels=token+request&template=token-request.md&title=Add+%7BTOKEN_SYMBOL%7D%3A+%7BTOKEN_NAME%7D).
## What is a Token List?

### Disclaimer
A token list is a JSON file that contains information about tokens such as:
- Token addresses
- Names
- Symbols
- Logos
- Decimals

Note filing an issue does not guarantee addition to this default token list.
We do not review token addition requests in any particular order, and we do not
guarantee that we will review your request to add the token to the default list.
This list is used by the Uniswap app to show tokens to users and help them interact safely.

---

## Getting Started

If you want to work on this project locally (e.g., to contribute or customize it), follow these steps:

### 1. Clone the Repository

First, clone the project to your local machine:

```bash
git clone https://github.com/Uniswap/default-token-list.git
cd default-token-list