docs(docs): added docs for published lib modules

xmlking · Jan 8, 2019 · 10861f7 · 10861f7
1 parent d5f7d4b
commit 10861f7
Show file tree

Hide file tree

Showing 23 changed files with 178 additions and 28 deletions.
diff --git a/PLAYBOOK.md b/PLAYBOOK.md
@@ -229,6 +229,7 @@ npm i -D lint-staged
 > update 3rd party modules/schematics
 
 ```bash
+ng update
 ng update @angular/core@next
 ng update @angular/cli@next
 ng update @angular/material --force

diff --git a/libs/app-confirm/README.md b/libs/app-confirm/README.md
@@ -2,6 +2,15 @@ Conform Popup
 =============
 confirm popup dialog to get user's choice.
 
+
+### Install
+
+```bash
+npm i @ngx-starter-kit/app-confirm
+```
+
+### Usage
+
 ```ts
 import { AppConfirmModule } from '@ngx-starter-kit/app-confirm'
 import { AppConfirmService } from '@ngx-starter-kit/app-confirm';

diff --git a/libs/breadcrumbs/README.md b/libs/breadcrumbs/README.md
@@ -1,6 +1,14 @@
 # Breadcrumbs
 
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/breadcrumbs
+```
+
+### Usage
+
 ### Publish
 ```bash
 # build

diff --git a/libs/chat-box/README.md b/libs/chat-box/README.md
@@ -6,7 +6,16 @@
 - multiple active conversations
 - save and retrieve active conversations
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/chat-box
+```
+
+### Usage
+
 ### Publish
+
 ```bash
 # build deps first
 ng build utils
@@ -19,7 +28,6 @@ export NPM_TOKEN="00000000-0000-0000-0000-000000000000"
 npm publish dist/libs/chat-box --access public
 ```
 
-
 TODO
 multiple conversations inspired by
 https://www.weave.works/
diff --git a/libs/chat-box/src/lib/state/chat-box.store.ts b/libs/chat-box/src/lib/state/chat-box.store.ts
@@ -30,7 +30,6 @@ import {
   SynthesisVoice,
 } from './chat-box.actions';
 
-
 export class ChatBoxStateModel {
   conversations: Conversation[];
   activeConversationId: string | number;

diff --git a/libs/clap/README.md b/libs/clap/README.md
@@ -2,18 +2,16 @@
 
 Clap micro-interaction
 
-### TODO
-
-1. How I Implemented the Medium Clap from Scratch!
+### Install
 
-- https://medium.com/@yonatandoron/how-i-implemented-the-medium-clap-from-scratch-4a16ac90ad3b
-
-2. Creating Reusable Animations in Angular
-
-- https://netbasal.com/creating-reusable-animations-in-angular-6a2350d6191a
+```bash
+npm i @ngx-starter-kit/clap
+```
 
+### Usage
 
 ### Publish
+
 ```bash
 # build
 ng build clap
@@ -22,3 +20,13 @@ export NPM_TOKEN="00000000-0000-0000-0000-000000000000"
 # publish
 npm publish dist/libs/clap --access public
 ```
+
+### TODO
+
+1. How I Implemented the Medium Clap from Scratch!
+
+- https://medium.com/@yonatandoron/how-i-implemented-the-medium-clap-from-scratch-4a16ac90ad3b
+
+2. Creating Reusable Animations in Angular
+
+- https://netbasal.com/creating-reusable-animations-in-angular-6a2350d6191a
diff --git a/libs/context-menu/README.md b/libs/context-menu/README.md
@@ -1,5 +1,11 @@
 # Context Menu
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/context-menu
+```
+
 ### Usage
 
 1.  Add `ContextMenuModule` module to your module `imports`
@@ -22,8 +28,8 @@
 <div [contextMenu]="myContextMenu">Right click me to see the menu</div>
 ```
 
-
 ### Publish
+
 ```bash
 # build
 ng build context-menu
@@ -32,4 +38,3 @@ export NPM_TOKEN="00000000-0000-0000-0000-000000000000"
 # publish
 npm publish dist/libs/context-menu --access public
 ```
-
diff --git a/libs/draggable/README.md b/libs/draggable/README.md
@@ -1,7 +1,15 @@
 # Draggable
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/draggable
+```
+
+### Usage
 
 ### Publish
+
 ```bash
 # build deps first
 ng build utils
@@ -13,4 +21,3 @@ export NPM_TOKEN="00000000-0000-0000-0000-000000000000"
 # publish
 npm publish dist/libs/draggable --access public
 ```
-
diff --git a/libs/image-comparison/README.md b/libs/image-comparison/README.md
@@ -1,5 +1,11 @@
 # Image Comparison
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/image-comparison
+```
+
 ### Usage
 
 ```html
@@ -14,6 +20,7 @@
 - [ImageComparison](https://github.com/M-Ulyanov/ImageComparison)
 
 ### Publish
+
 ```bash
 # build
 ng build image-comparison

diff --git a/libs/json-diff/README.md b/libs/json-diff/README.md
@@ -1,7 +1,15 @@
 # Json Diff
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/json-diff
+```
+
+### Usage
 
 ### Publish
+
 ```bash
 # build
 ng build json-diff

diff --git a/libs/led/README.md b/libs/led/README.md
@@ -1,7 +1,15 @@
 # Led
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/led
+```
+
+### Usage
 
 ### Publish
+
 ```bash
 # build
 ng build led

diff --git a/libs/loading-overlay/README.md b/libs/loading-overlay/README.md
@@ -1,7 +1,15 @@
 # loading-overlay
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/loading-overlay
+```
+
+### Usage
 
 ### Publish
+
 ```bash
 # build
 ng build loading-overlay

diff --git a/libs/ngx-utils/README.md b/libs/ngx-utils/README.md
@@ -6,6 +6,14 @@ same as [@ngrx-utils/store](https://github.com/ngrx-utils/ngrx-utils) without de
 
 **Directive:** inViewport, ngLet, routerLinkMatch
 
+## Install
+
+```bash
+npm i @ngx-starter-kit/ngx-utils
+```
+
+## Usage
+
 ### InViewport Directive
 
 > Add `IntersectionObserver` [polyfill](https://github.com/w3c/IntersectionObserver/tree/master/polyfill) to [polyfills.ts](../../apps/webapp/src/polyfills.ts) for `Safari` Support
@@ -16,14 +24,14 @@ same as [@ngrx-utils/store](https://github.com/ngrx-utils/ngrx-utils) without de
 </div>
 ```
 
-> If `entry.intersectionRatio >= 0.5` ==> `Inside Viewport`
-> <br/>
+> If `entry.intersectionRatio >= 0.5` ==> `Inside Viewport` > <br/>
 > If `entry.intersectionRatio < 0.5` ==> `Outside Viewport`
 
 #### Flags
-1. Trigger only One Time : `[oneTime]="true"`  usecase: image loading. 
+
+1. Trigger only One Time : `[oneTime]="true"` usecase: image loading.
 2. Server-Side Rendering : By default, loads the elements on the server.
-> If you do not want to pre-render the elements in server, you can set `preRender to false. i.e., `[preRender]="false"`
+   > If you do not want to pre-render the elements in server, you can set `preRender to false. i.e.,`[preRender]="false"`
 
 ### Viewport Service
 
@@ -61,8 +69,8 @@ export class ViewportDemoComponent implements OnInit, OnDestroy {
 }
 ```
 
+## Publish
 
-### Publish
 ```bash
 # build
 ng build ngx-utils

diff --git a/libs/notifications/README.md b/libs/notifications/README.md
@@ -1,7 +1,15 @@
 # Notifications
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/notifications
+```
+
+### Usage
 
 ### Publish
+
 ```bash
 # build
 ng build notifications

diff --git a/libs/scroll-to-top/README.md b/libs/scroll-to-top/README.md
@@ -1,6 +1,15 @@
 # Scroll-to-Top
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/scroll-to-top
+```
+
+### Usage
+
 ### Publish
+
 ```bash
 # build
 ng build scroll-to-top

diff --git a/libs/scrollbar/README.md b/libs/scrollbar/README.md
@@ -1,7 +1,15 @@
 # Scrollbar
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/scrollbar
+```
+
+### Usage
 
 ### Publish
+
 ```bash
 # build
 ng build scrollbar

diff --git a/libs/socketio-plugin/README.md b/libs/socketio-plugin/README.md
@@ -1,6 +1,15 @@
 # socketio-plugin
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/socketio-plugin
+```
+
+### Usage
+
 ### Publish
+
 ```bash
 # build
 ng build socketio-plugin

diff --git a/libs/svg-viewer/README.md b/libs/svg-viewer/README.md
@@ -1,7 +1,15 @@
 # Svg-Viewer
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/svg-viewer
+```
+
+### Usage
 
 ### Publish
+
 ```bash
 # build
 ng build svg-viewer

diff --git a/libs/theme-picker/README.md b/libs/theme-picker/README.md
@@ -1,7 +1,15 @@
 # Theme-Picker
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/theme-picker
+```
+
+### Usage
 
 ### Publish
+
 ```bash
 # build
 ng build theme-picker

diff --git a/libs/tree/README.md b/libs/tree/README.md
@@ -1,7 +1,15 @@
 # Tree
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/tree
+```
+
+### Usage
 
 ### Publish
+
 ```bash
 # build
 ng build tree

diff --git a/libs/utils/README.md b/libs/utils/README.md
@@ -1,7 +1,15 @@
 # Utils
 
+### Install
+
+```bash
+npm i @ngx-starter-kit/utils
+```
+
+### Usage
 
 ### Publish
+
 ```bash
 # build
 ng build utils