Merge branch 'feature/docs-v1.1.0'

CHANGELOG.md

@@ -1,3 +1,7 @@
+## RELEASE 1.1.1
+### Feature
+* Add more docs for useClass
+
 ## RELEASE 1.1.0
 ### Feature
 * Add full support for useClass and useExisting

README.md

@@ -37,7 +37,7 @@ const rates = {
 export class AppModule {}
 ```
 
-### forRootAsync with configuration
+### forRootAsync with configuration and useFactory
 
 ```TS
 @Module({
@@ -54,6 +54,43 @@ export class AppModule {}
 export class AppModule {}
 ```
 
+### forRootAsync with configuration and useClass
+
+```TS
+@Module({
+  imports: [
+    CashifyModule.forRootAsync({
+      useClass: CashifyConfigService,
+      import: [ConfigModule],
+      extraProviders: [ConfigService],
+    })
+  ]
+})
+export class AppModule {}
+```
+And for `CashifyConfigService` we have the following:
+
+```TS
+import { CashifyOptionsFactory } from 'nestjs-cashify';
+
+@Injectable()
+export class CashifyConfigService implements CashifyOptionsFactory {
+  constructor(private configService: ConfigService) {}
+
+  createCashifyOptions() {
+    const rates = {
+      GBP: 0.92,
+      EUR: 1.00,
+      USD: 1.12
+    };
+    return {
+      base: this.configService.get<string>('BASE'),
+      rates
+    };
+  }
+}
+```
+
 ## Convert
 
 In order to convert currencies to each other in controllers or services, we have two approaches:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-cashify",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Currency conversion module for nest",
   "author": "Vahid Najafi <vahid.vdn@gmail.com>",
   "license": "MIT",