Merge pull request #1573 from RoadieHQ/punkle-patch-4

Add details about how to configure the gravatar plugin

plugins/backend/catalog-backend-module-gravatar/README.md

@@ -7,3 +7,28 @@ The `@roadiehq/catalog-backend-module-gravatar` package provides a custom Backst
 - **Automatic Gravatar URL Generation**: The processor generates a Gravatar URL for each user based on their email address using the MD5 hash.
 - **Profile Picture Population**: The generated Gravatar URL is added to the `spec.profile.picture` field of `User` entities.
 - **Seamless Integration**: This processor integrates easily with the Backstage catalog processing pipeline.
+
+## How to use
+
+You can edit the `src/plugins/catalog.ts` of the backstage backend and add the following:
+
+```
+import { GravatarProcessor } from '@roadiehq/catalog-backend-module-gravatar';
+
+export default async function createPlugin(
+  env: PluginEnvironment,
+): Promise<Router> {
+  const builder = await CatalogBuilder.create(env);
+
+  // ...
+
+  builder.addProcessor(new GravatarProcessor());
+
+  const { processingEngine, router } = await builder.build();
+  await processingEngine.start();
+
+  // ...
+
+  return router;
+}
+```