From 3a0f39f3e5d7d85b6fc01e8397312b48d53d763d Mon Sep 17 00:00:00 2001 From: Kevin Peters Date: Tue, 2 Apr 2024 11:29:12 -0500 Subject: [PATCH] Added NTT to README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index c57916793..6c7039ca8 100644 --- a/README.md +++ b/README.md @@ -131,6 +131,21 @@ See the "Arbitrary Token" example in [the config docs](https://docs.wormhole.com Please note you have to [register a token](https://portalbridge.com/advanced-tools/#/register) with the token bridge before you can use it in Connect. +### Configuring Custom NTT (Native Token Transfer) Groups +To configure custom NTT groups, include an `nttGroups` key in your configuration. + +```ts +const config: WormholeConnectConfig = { + nttGroups: { + // Your custom NTT groups go here + } +} +``` + +For a practical example of how to structure your custom NTT groups, refer to the [nttGroups.ts](https://github.com/wormhole-foundation/wormhole-connect/blob/development/wormhole-connect/src/config/testnet/nttGroups.ts) file. + +Please note that the `tokenKey` specified in your custom NTT group must correspond to an existing entry in the tokensConfig, whether it's a built-in or a custom token. + ### Custom Theme You can also customize Connect's color scheme by providing a `WormholeConnectTheme` as the `theme` prop.