Updated config example

dl-solarity · Nov 4, 2024 · e57e65f · e57e65f
1 parent cee807a
commit e57e65f
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -29,11 +29,13 @@ To create a `CircuitTypesGenerator` object, it is necessary to pass a config:
 
 ```typescript
 ZKTypeConfig = {
-  basePath: string;
-  projectRoot: string;
-  circuitsASTPaths: string[];
-  outputTypesDir?: string;
-};
+  basePath: "circuits",
+  projectRoot: process.cwd(),
+  circuitsArtifactsPaths: [
+    "circuits/auth/Matrix_artifacts.json",
+  ],
+  outputTypesDir: "generated-types/circuits",
+}
 ```
 
 This config contains all the information required to generate TypeScript bindings for given circuits.