From b49ef3c152bf0c92cce339741e590503bb3ee598 Mon Sep 17 00:00:00 2001 From: Alex Harley Date: Sat, 20 Apr 2024 09:42:43 +1200 Subject: [PATCH] chore: basic readme --- readme.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..080a04b --- /dev/null +++ b/readme.md @@ -0,0 +1,10 @@ +# Superbridge token lists + +We use this repository for accepting token listings on [superbridge.app](https://superbridge.app). + +To get your token listed, simply open a PR adding the relevant file to the `data` folder. Checks will run to ensure this token is a valid and bridgeable token. For reference, please see [the example](https://github.com/superbridgeapp/token-lists/pull/11) of a valid token listing PR. + +Please note that for most token listings your PR will need either, + +- to be created by a representative of the project +- include have a verifying tweet from the project Twitter account.