fix: expose utils "is"

Author: nartc

README.md

@@ -1,17 +1,3 @@
-# AngularThree
+# AngularThree workspace
 
-<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
-
-✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨
-
-## Understand this workspace
-
-Run `nx graph` to see a diagram of the dependencies of the projects.
-
-## Remote caching
-
-Run `npx nx connect-to-nx-cloud` to enable [remote caching](https://nx.app) and make CI faster.
-
-## Further help
-
-Visit the [Nx Documentation](https://nx.dev) to learn more.
+Here, you'll find the main `angular-three` library and a `demo` application

libs/angular-three/README.md

@@ -1,7 +1,58 @@
-# angular-three
+# Angular Renderer for THREE.js
 
-This library was generated with [Nx](https://nx.dev).
+Leverage your [Angular](https://angular.io) to build 3D applications with [THREE.js](https://threejs.org)
 
-## Running unit tests
+## Installation
 
-Run `nx test angular-three` to execute the unit tests.
+```shell
+npm i angular-three three
+```
+
+```shell
+npm i -D @types/three
+```
+
+> Typically, we'd want to keep `three` and `@types/three` on the same minor version. Eg: `0.147`, `0.148` etc..
+
+## Simple usage
+
+1. Create a `Scene` component as a Standalone Component
+
+```ts
+import { extend } from 'angular-three';
+import { Mesh, BoxGeometry, MeshBasicMaterial } from 'three';
+
+extend({ Mesh, BoxGeometry, MeshBasicMaterial });
+
+@Component({
+    standalone: true,
+    template: `
+        <ngt-mesh>
+            <ngt-box-geometry />
+            <ngt-mesh-basic-material color="darkred" />
+        </ngt-mesh>
+    `,
+    schemas: [CUSTOM_ELEMENTS_SCHEMA],
+})
+export class Scene {}
+```
+
+-   `extend` will add the THREE entities to `angular-three` catalogue which allows the renderer to recognize the custom tags: `ngt-mesh`, `ngt-box-geometry` etc..
+-   Custom Element tags follow this rule: `ngt-` + THREE classes in **kebab-case**. `Mesh` -> `ngt-mesh`
+-   `schemas: [CUSTOM_ELEMENTS_SCHEMA]` allows us to use custom tags on the template. This is Angular's limitation at the moment
+
+2. Render `<ngt-canvas>` component, use `Scene` component above to pass into `[scene]` input on `<ngt-canvas>`
+
+```html
+<ngt-canvas [scene]="Scene" />
+```
+
+-   `ngt-canvas` creates the basic building blocks of THREE.js: a default `WebGLRenderer`, a default `Scene`, and a default `PerspectiveCamera`
+
+## Documentations
+
+Read more about Angular Three usages in [TBD Documentations]()
+
+## Contributions
+
+Contributions are welcomed

libs/angular-three/src/index.ts

@@ -7,6 +7,7 @@ export * from './lib/stores/store';
 export * from './lib/stores/rx-store';
 export * from './lib/utils/instance';
 export * from './lib/utils/update';
+export * from './lib/utils/is';
 export * from './lib/loader';
 export * from './lib/di/ref';
 export * from './lib/di/destroy';