Skip to content

Commit

Permalink
Update customize.md instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
@jmrossy
jmrossy committed Jul 22, 2023
1 parent e0281c1 commit 9a68687
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 13 deletions.
17 changes: 5 additions & 12 deletions CUSTOMIZE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,17 @@

Find below instructions for customizing the token list and branding assets of this app.

## Token List
## Token Configs

This app requires a token list to function. The token list is located at `./src/consts/tokens.ts`. The output of a warp route deployment using the [Hyperlane-Deploy](https://docs.hyperlane.xyz/docs/deploy/deploy-hyperlane) tools will work here.
This app requires a token config list to function. The token list is located at `./src/consts/tokens.ts`. The output token artifacts of a warp route deployment using the [Hyperlane-Deploy](https://docs.hyperlane.xyz/docs/deploy/deploy-hyperlane) tools can be used here.

## Permissionless Chain Support

_This section is only relevant if you want to include chains not already supported by Hyperlane._
## Chain Configs

By default, the app will use only the chains that are included in the Hyperlane SDK and connected to the tokens you specify in the token list (see above).

To add support for additional chains, fill in the required chain metadata in `./src/consts/chains.ts`. You can also use this file to override any default chain configs set in the SDK. The chains config using in the [Hyperlane-Deploy](https://docs.hyperlane.xyz/docs/deploy/deploy-hyperlane) tools will work here. You may also add an optional `logoURI` field to the each chain config.

## RPC Providers

By default, the app uses public RPC providers based on the Hyperlane SDK's default settings.
This can be changed in '`./src/features/providers.ts`.
To add support for additional chains, or to modify the default properties of the SDK's chains (such as RPC URL), add the required chain metadata to `./src/consts/chains.ts`. The same chain config used in the [Hyperlane-Deploy](https://docs.hyperlane.xyz/docs/deploy/deploy-hyperlane) tools will work here. You may also add an optional `logoURI` field to a chain config to show a custom logo image in the app.

## Tip Card Content
## Tip Card

The content of the tip card above the form can be customized in `./src/components/tip/TipCard.tsx`
Or it can be hidden entirely with the `showTipBox` setting in `./src/consts/config.ts`
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ yarn clean

## Deployment

The recommended hosting solution for this Next.JS app is to create a project on Vercel.
The easiest hosting solution for this Next.JS app is to create a project on Vercel.

## Learn more

Expand Down

1 comment on commit 9a68687

@vercel
Copy link

@vercel vercel bot commented on 9a68687 Jul 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

hyperlane-warp-template – ./

hyperlane-warp-template-abacus-works.vercel.app
hyperlane-warp-template-git-main-abacus-works.vercel.app
hyperlane-warp-template.vercel.app

Please sign in to comment.