Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mykola committed Jan 2, 2020
1 parent 161c4a3 commit 0eef662
Showing 1 changed file with 16 additions and 18 deletions.
34 changes: 16 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
# Trust Wallet Assets Info

```diff
- On November 8th 2019 we made big changes to the repository, please read summary and recomnadations
```

### What changed:
- Assets in fodler `assets` and validators assets in `validators/assets` were changed from lowercased format to checksum format e,g: Binance BEP2: busd-bd1 => BUSD-BD1, Ethreum ERC20 token: 0xfff3ada5a2555a2b59bff4f44dfad90146cce8cb => 0xffF3ada5A2555a2B59BfF4F44DFad90146CcE8CB
- Added scripts that generates white and black list of contract assets list

### What to do next:
- If you first time contributor nothing required, just simple follow repository contribution guidelines
- If you contributed before nad planning on continue please upgrade your fork from latest master or simple delete your fork and fork again to save your time dealing with merge conflicts

## Overview
Hello and welcome to Trust Wallet assets info contribution guide. We appreciate your effort to open-source.
Token repository [https://github.com/trustwallet/assets](https://github.com/trustwallet/assets) (repo) is a source of images used by [Trust Wallet](https://trustwallet.com/) including:
Expand Down Expand Up @@ -42,12 +30,19 @@ Token repository [https://github.com/trustwallet/assets](https://github.com/trus

## Contribution steps

1. Prepare image [requirements](#image-requirements)
2. Get familiar with [folder strcture](#repository-structure), will give you understanding where asset image should be placed
### Add new asset

1. Prepare asset, look at [image requirements](#image-requirements), [dapp requirements](#dApp-image-naming-requirments)
2. Get familiar with [folder strcture](#repository-structure), will give you understanding where asset should be placed
3. [Add asset guide](#how-to-add-asset)

### Update or remove existing asset

Whenever you updating or deleting asset on behalf of asset owner or just found outdated information, please provide link to the source saying about changes. That will help to speed up review process


## Image Requirements
- file extension: `png`. Uppercase `PNG` considered invalid.
- file extension: `png`. Uppercase `PNG` considered invalid
- name:file name requirements for: `logo.png` name, but [folder naming](#repository-structure) where they placed is most important part of contribution
- size: `256px by 256px` or `512px by 512px`
- background: preferably transparent
Expand All @@ -59,10 +54,10 @@ Token repository [https://github.com/trustwallet/assets](https://github.com/trus
https://app.compound.finance/ => `app.compound.finance.png`
https://kyberswap.com/ => `kyberswap.com.png`

## dApp subbmition and listing requirements
- Integrate [deep linking](https://developer.trustwallet.com/deeplinking) first
## dApp submission and listing requirements
- Integrate [deep linking](https://developer.trustwallet.com/deeplinking)
- Add [logo](https://trustwallet.com/press) as dApp supported wallet
- Test dApp inside Trust Wallet on iOS and Android devices
- Test dApp inside Trust Wallet on iOS and Android devices, test one more time
- [Submit form for review](https://docs.google.com/forms/d/e/1FAIpQLSd5p9L78zKXIiu9E5yFRPf5UkvsLZ7TbUDLFBRIi1qMd8Td4A/viewform)

## Repository structure
Expand Down Expand Up @@ -170,6 +165,9 @@ git push origin <branch_name>
### Why do I still see old logo in Trust Wallet after uploaded new one
Both clients, Android and iOS keep old image cache for up to 7 days. In order to see changes immediately, reinstall Trust Wallet. But as always, make sure you have a backup of all your wallets.

### Why i don't see my token in search after PR was merged ?
After PR was merged, set of cron workers will update token status normally with in 10 minutes and sometimes up to 30 minutes and token became visible in search result.

## How to use it? (For Developers)
Base URL for token image:
```js
Expand Down

0 comments on commit 0eef662

Please sign in to comment.