docs: improve readme

Author: thomasthiebaud

README.md

@@ -38,3 +38,109 @@ Options:
   -e, --ext <value>     file extension to use for generated files (default: ".ts")
   -h, --help            display help for command
 ```
+
+## Project example
+
+Here is a project structure that I'm usually using with that module.
+Each endpoint has a folder with a `schema.yaml` and `index.ts`
+
+```
+package.json
+src/
+  app.ts
+  api/
+    healtheck/
+      index.ts
+      schema.yaml
+    anotherEndpoint/
+      index.ts
+      schema.yaml
+    ...
+```
+
+Running `npx fastify-schema-to-typescript` will convert `schema.yaml` to `schema.ts` that you can then you in your apps like that
+
+app.ts
+
+```
+import fastify from 'fastify';
+import { healthcheck } from './api'
+
+export async function run() {
+  const app = fastify();
+  await app.register(healthcheck);
+
+  await app.listen(3000);
+}
+
+run();
+```
+
+api/index.ts
+
+```
+export * from './healthcheck';
+```
+
+api/healtheck/schema.yaml
+
+```
+headers:
+  type: object
+  properties:
+    ...
+
+body:
+  type: object
+  properties:
+    ...
+
+query:
+  type: object
+  properties:
+    ...
+
+params:
+  type: object
+  properties:
+    ...
+```
+
+api/healtheck/index.ts
+
+```
+import { FastifyPluginAsync } from 'fastify';
+import { RouteGeneric, schema } from './schema';
+
+export const getHealthcheck: FastifyPluginAsync = async (app) => {
+  app.get<RouteGeneric>('/healthcheck', { schema }, async () => {
+    return { ok: true };
+  });
+};
+```
+
+I usually add the following in my package.json so I'm sure the code is in syn with the schemas
+
+package.json
+
+```
+...
+"scripts": {
+  ...
+  "build": "npm run clean && npm run generate && npm run compile",
+  "compile": "tsc",
+  "clean": "rimraf dist",
+  "generate": "npx fastify-schema-to-typescript",
+  ...
+}
+```
+
+and I also update `.gitignore` to not include the generate `schema.ts`
+
+.gitignore
+
+```
+...
+schema.ts
+...
+```