publish(1.0.3): publish to npm

Author: MarkPieszak

libraries/ng-universal/README.md

@@ -1,4 +1,4 @@
-# Angular Universal Helpers - Trilon
+# Angular Universal Schematics & Helpers - Trilon
 
 [![npm](https://img.shields.io/npm/v/@trilon/ng-universal.svg?label=npm%20version&color=5b1096&style=for-the-badge)](https://www.npmjs.com/@trilon/ng-universal)
 [![NPM Downloads](https://img.shields.io/npm/dt/@trilon/ng-universal.svg?color=b31ae7&style=for-the-badge)](https://www.npmjs.com/@trilon/ng-universal)
@@ -17,7 +17,7 @@
 
 ---
 
-## Installation 
+## Installation
 
 Install & save the library to your package.json:
 
@@ -33,24 +33,58 @@ Now add ApplicationInsightsModule to your Angular Root `AppModule`:
 
 ```typescript
 // Import the Application Insights module and the service provider
-import { --TODO-- } from '@trilon/ng-universal';
+import { NgUniversalModule } from '@trilon/ng-universal';
 
 @NgModule({
   imports: [
-    // ... your imports
-
+    // ...
     // Add the Module to your imports
-    
-  ],
-  // ... providers / etc
-  providers: [ ],
+    NgUniversalModule
+  ]
 })
 export class AppModule { }
 ```
 
-## Usage
+# Angular Universal Helpers 
+
+Now that the Library is setup, you have a few great helpers to make Angular Universal a bit simpler and easier to work with!
+
+## PlatformService
+
+Typically in Angular Universal Applications you have sections of code that can only run in certain platforms (browser or server), with PlatformService you can simply add it in the constructor of any Component/Service within your application, and run code specific to that platform - without causing Errors in the _other_ platform.
+
+```ts
+import { PlatformService } from '@trilon/ng-universal';
+
+@Component({ /* ... */ })
+export SomeComponent {
+  constructor(private platformService: PlatformService) {
+    if (platformService.isBrowser) {
+      // Run browser-specific code that would cause errors in the Server/Node platform!
+      // $('body').addClass('');
+    }
+
+    if (platformService.isServer) {
+      // Run Server/Node-specific code
+    }
+  }
+}
+
+```
+
+## IsBrowser | IsService Directives
+
+Equally important with Angular Universal is displaying only Components/UI that are _neccessary_ for the given platform.  To improve performance, or to avoid Components all-together we can use `*isBrowser` or `*isServer` Directives to display/hide specific things given a platform.
+
+Take as an example a Twitter Feed section that's connected to 3rd party Components/Libraries and API-calls. We don't need Universal to display these as there is no SEO benefit, and most likely they will slow down our Render time.  In this case it's most beneficial to simply avoid it entirely during server-side rendering, and have _only_ the **Browser** display and render this Component!
+
+```html
+<ng-container *isBrowser>
+  <app-twitter-feed></app-twitter-feed>
+</ng-container>
+```
 
-To do ....
+More Documentation Coming soon...
 
 
 # License

libraries/ng-universal/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@trilon/ng-universal",
   "description": "Angular Universal Schematics and Helpers - Brought to you by Trilon.io",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "author": {
     "name": "Trion",
     "email": "hello@trilon.io",
     "url": "https://trilon.io"
   },
+  "homepage": "https://trilon.io",
   "contributors": [
     {
       "name": "Mark Pieszak",
@@ -28,9 +29,9 @@
   },
   "license": "MIT",
   "peerDependencies": {
-    "@angular/common": "^7.2.0",
-    "@angular/core": "^7.2.0",
-    "@angular/platform-browser": "^7.2.0"
+    "@angular/common": "^7.0.0",
+    "@angular/core": "^7.0.0",
+    "@angular/platform-browser": "^7.0.0"
   },
   "keywords": [
     "angular",

package.json

@@ -7,7 +7,7 @@
     "build": "ng build",
     "build:ng-universal": "rm -rf ./dist/ng-universal && ng build ng-universal &&  npm run pack:ng-universal",
     "pack:ng-universal": "cd dist/ng-universal && npm pack",
-    "publish:ng-universal": "npm publish ./dist/ng-universal/trilon-ng-universal-1.0.0.tgz --access=public",
+    "publish:ng-universal": "npm publish ./dist/ng-universal/trilon-ng-universal-1.0.3.tgz --access=public",
     "test": "ng test",
     "lint": "ng lint",
     "e2e": "ng e2e",