diff --git a/src/tokenlists/README.md b/src/tokenlists/README.md index 0820f689..8e5993d4 100644 --- a/src/tokenlists/README.md +++ b/src/tokenlists/README.md @@ -5,17 +5,17 @@ To create a new token list run: ```shell -npm run tokenlists:create my-new-tokenlist +npm run tokenlist:create my-new-tokenlist ``` -This will generate two files nest in a folder called +This will generate two files nested in a folder called `tokenlists/my-new-tokenlist`: 1. tokens.ts - Add token addresses here that you want to include in your tokenlist 2. overwrites.ts - Add overwrite data here for specific token addresses. -## Add new tokens it existing list +## Add new tokens to an existing list To add new tokens to an existing tokenlist, add the token address to the `tokens.ts` file within the relevant network key. @@ -27,7 +27,7 @@ To remove a token from an existing tokenlist, remove the token address from the ## Overwrite tokenlist output data -To overwrite token metadata produced in the tokenslist, add the desired metadata +To overwrite token metadata produced in the tokenlist, add the desired metadata to the overwrites file where the key is the token address and the value is the overwrite data you want to inject. For example, if you simply wanted to make sure the token name for WETH was 'Wrapped Ether' then you would add: diff --git a/tsconfig.json b/tsconfig.json index f3b4dc5b..7c9aeac2 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,7 +1,7 @@ { "$schema": "https://json.schemastore.org/tsconfig", "display": "Default", - "include": ["src/**/*", "scripts/generate-lists.ts", "scripts/generate-lists.ts"], + "include": ["src/**/*"], "exclude": ["node_modules", "src/lib/templates/**/*"], "compilerOptions": { "composite": false, @@ -19,7 +19,7 @@ "strict": true, "noUnusedLocals": false, "noUnusedParameters": false, - "skipLibCheck": true, + "skipLibCheck": true, "inlineSourceMap": true, "allowSyntheticDefaultImports": true }