chore(README): update readme with generate-type-bundle tool (#1004)

paritytech · Aug 2, 2022 · 45b25bf · 45b25bf
1 parent fedfaee
commit 45b25bf
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/README.md b/README.md
@@ -168,7 +168,7 @@ For more information on our configuration manager visit its readme [here](https:
 
 Some chains require custom type definitions in order for Sidecar to know how to decode the data
 retrieved from the node. Sidecar affords environment variables which allow the user to specify an absolute path to a JSON file that contains type definitions in the corresponding formats. Consult polkadot-js/api for more info on
-the type formats (see `RegisteredTypes`).
+the type formats (see `RegisteredTypes`). There is a helper CLI tool called [generate-type-bundle](https://github.com/paritytech/generate-type-bundle) that can generate a `typesBundle.json` file for you using chain information from [`@polkadot/apps-config`](https://github.com/polkadot-js/apps/tree/master/packages/apps-config). The generated json file from this tool will work directly with the `SAS_SUBSTRATE_TYPES_BUNDLE` ENV variable. 
 
 - `SAS_SUBSTRATE_TYPES_BUNDLE`: a bundle of types with versioning info, type aliases, derives, and
     rpc definitions. Format: `OverrideBundleType` (see [`typesBundle`](https://github.com/polkadot-js/api/blob/21039dec1fcad36061a96bf5526248c5fab38780/packages/types/src/types/registry.ts#L72)).