Merge pull request #279 from IlmariKu/patch-1

Example on how to add the openapi-extension to your code

README.md

@@ -123,7 +123,11 @@ It has three overloads:
 
 For this to work, you need to call `extendZodWithOpenApi` once in your project.
 
-Note: This should be done only once in a common-entrypoint file of your project (for example an `index.ts`/`app.ts`). If you're using tree-shaking with Webpack, mark that file as having side-effects.
+This should be done only once in a common-entrypoint file of your project (for example an `index.ts`/`app.ts`). If you're using tree-shaking with Webpack, mark that file as having side-effects.
+
+It can be bit tricky to achieve this in your codebase, because *require* is synchronous and *import* is a async.
+
+### The basic idea
 
 ```ts
 import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
@@ -135,6 +139,35 @@ extendZodWithOpenApi(z);
 z.string().openapi({ description: 'Some string' });
 ```
 
+### Example 1: Calling the openapi-extension using tsx
+
+```
+//zod-extend.ts
+
+import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
+import { z } from 'zod';
+
+extendZodWithOpenApi(z);
+
+// package.json
+
+  "scripts": {
+    "start": "tsx --import ./zod-extend.ts ./index.ts",
+```
+
+### Example 2 - require-syntax
+
+```
+import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi';
+import { z } from 'zod';
+
+extendZodWithOpenApi(z);
+
+const { startServer } = require('./server/start');
+startServer();
+```
+
+
 ### The Registry
 
 The `OpenAPIRegistry` is a utility that can be used to collect definitions which would later be passed to a `OpenApiGeneratorV3` or `OpenApiGeneratorV31` instance.