Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
moodysalem authored Jul 14, 2020
1 parent ce4d545 commit dab9a8e
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,14 @@ List versions must follow the rules:

- Increment major version when tokens are removed
- Increment minor version when tokens are added
- Increment patch version when tokens already on the list have minor details changed (name, symbol, logo URL)
- Increment patch version when tokens already on the list have minor details changed (name, symbol, logo URL, decimals)

Changing a token address or chain ID is considered both a remove and an add, and should be a major version update.

Note that list versioning is used to improve the user experience, but not for security, i.e. list versions are not meant
to provide protection against malicious updates to a particualr token list; i.e. the list semver is just a lossy compression
of the diff of list updates.

## Deploying your list

Once you have authored the list, you can make it available at any URI. Prefer pinning your list to IPFS
Expand Down

0 comments on commit dab9a8e

Please sign in to comment.