📝 Improved sample usage of template-type-checker project

Author: SwabianCoder

projects/template-type-checker/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0-rc.2] - 2022-08-15
+
+### Changed
+
+- Sample usage
+
 ## [1.0.0-rc.1] - 2022-08-14
 
 ### Added

projects/template-type-checker/README.md

@@ -13,8 +13,8 @@
     - [NPM](#npm)
   - [Usage](#usage)
     - [Module Import](#module-import)
-    - [HTML](#html)
     - [TS](#ts)
+    - [HTML](#html)
 
 ## Features
 
@@ -46,32 +46,43 @@ import { TemplateTypeCheckerModule } from '@ngx-toolset/template-type-checker';
 export class SampleModule {}
 ```
 
-### HTML
-
-```angular2html
-<div *ngIf="sampleObject | typeChecker:classA">
-</div>
-```
-
 ### TS
 
 ```ts
 import { Component } from '@angular/core';
 
 class ClassA {}
 
+class ClassB {}
+
 @Component({
   selector: 'app-sample',
   templateUrl: './sample.component.html',
   styleUrls: ['./sample.component.scss']
 })
 export class ProductAlertsComponent {
   public classA: typeof ClassA;
+  public classB: typeof ClassB;
   public sampleObject: ClassA;
 
   public constructor() {
     this.classA = ClassA;
+    this.classB = ClassB;
     this.sampleObject = new ClassA();
   }
 }
+```
+
+### HTML
+
+```html
+<!-- TypeCheckerPipe returns object of type ClassA -> ngIf evaluates to truthy value -->
+<div *ngIf="sampleObject | typeChecker:classA">
+  This div will be rendered.
+</div>
+
+<!-- TypeCheckerPipe returns undefined -> ngIf evaluates to falsy value -->
+<div *ngIf="sampleObject | typeChecker:classB">
+  This div will not be rendered.
+</div>
 ```

projects/template-type-checker/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ngx-toolset/template-type-checker",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "description": "Angular template class type check support",
   "homepage": "https://github.com/SwabianCoder/ngx-toolset",
   "license": "MIT",