feat: improving invitation module readme

packages/nestjs-invitation/README.md

@@ -1,6 +1,6 @@
 # Rockets NestJS Invitation
 
-Invite user by email
+Create/validate invitations for your rockets modules with ease.
 
 ## Project
 
@@ -10,6 +10,106 @@ Invite user by email
 [![GH Contrib](https://img.shields.io/github/contributors/conceptadev/rockets?logo=github)](https://github.com/conceptadev/rockets/graphs/contributors)
 [![NestJS Dep](https://img.shields.io/github/package-json/dependency-version/conceptadev/rockets/@nestjs/common?label=NestJS&logo=nestjs&filename=packages%2Fnestjs-core%2Fpackage.json)](https://www.npmjs.com/package/@nestjs/common)
 
+## Introduction
+
+Invitations are useful for create users, grant roles... You can integrate this invitation module with other rockets modules (e.g. users, roles, emails...) in order ease invitations.
+
+## Features
+
+- Create users by **_POST /invitation_**
+- Get invites by **_GET /invitation_**
+- Get one invite by **_GET /invitation/{id}_**
+- Delete one invite by **_DELETE /invitation/{id}_**
+- Validate one invite by **_GET /invitation-acceptance/{id}_**
+- Claim one invite by **_PATCH /invitation-acceptance/{id}_**
+
+For more details check invitation modules [swagger](http://host:port/api/#/invitation)
+
 ## Installation
 
-`yarn add @concepta/nestjs-invitation`
+$ `yarn add @concepta/nestjs-invitation @concepta/nestjs-crud @concepta/nestjs-email @concepta/nestjs-event @concepta/nestjs-otp @concepta/nestjs-typeorm-ext @concepta/nestjs-user @concepta/typeorm-common`
+
+At your `app.module.ts` you should configure OTP, USER, EMAIL modules with it's entities and services. Look at `packages/nestjs-invitation/src/__fixtures__/app.module.fixture.ts` for examples how to use it.
+
+```typescript
+EventModule.forRoot({}),
+  ConfigModule.forRoot({
+    isGlobal: true,
+    load: [ormConfig],
+  }),
+  TypeOrmExtModule.registerAsync({
+    inject: [ormConfig.KEY],
+    useFactory: async (config: ConfigType<typeof ormConfig>) => config,
+  }),
+  CrudModule.forRoot({}),
+  EmailModule.forRoot({
+    mailerService: {
+      sendMail(sendMailOptions): Promise<void> {
+        Logger.debug('email sent', sendMailOptions);
+
+        return Promise.resolve();
+      },
+    },
+  }),
+  InvitationModule.registerAsync({
+    imports: [UserModule.deferred(), OtpModule.deferred()],
+    inject: [UserLookupService, UserMutateService, OtpService, EmailService],
+    useFactory: (
+      userLookupService,
+      userMutateService,
+      otpService,
+      emailService,
+    ) => ({
+      userLookupService,
+      userMutateService,
+      otpService,
+      emailService,
+    }),
+    entities: {
+      invitation: {
+        entity: InvitationEntity,
+      },
+    },
+  }),
+  OtpModule.register({
+    entities: {
+      'user-otp': {
+        entity: UserOtpEntity,
+      },
+    },
+  }),
+  UserModule.register({
+    settings: {
+      invitationRequestEvent: InvitationAcceptedEventAsync,
+    },
+    entities: {
+      user: { entity: UserEntity },
+    },
+  })
+```
+
+## Required rocket modules
+In order to invitation module work you need to also add the following modules
+
+* ### Rockets NestJS User
+    A module for managing a basic User entity, including controller with full CRUD, DTOs, sample data factory and seeder.
+
+* ### Rockets NestJS CRUD
+    Extremely powerful CRUD module that is an extension/wrapper of the popular [@nestjsx/crud](https://github.com/nestjsx/crud) module.
+
+* ### Rockets NestJS Email
+    Email deliver module that supports the popular [@nestjs-modules/mailer](https://www.npmjs.com/package/@nestjs-modules/mailer) module.
+
+* ### Rockets NestJS Events
+    Advanced class based event dispatch/listener module.
+
+* ### Rockets NestJS Otp
+    A module for managing a basic Otp entity, including controller with full CRUD, DTOs, sample data factory and seeder.
+
+* ### Rockets TypeORM Common
+    The common module contains commonly used TypeORM embeds, utilities.
+
+* ### Rockets NestJS TypeOrm Extended
+    Extremely powerful extension of the NestJS TypeOrm module that allows your
+    dynamic modules to accept drop-in replacements of custom entities
+    and repositories at registration time.