Update README

Author: AXeL-dev

README.md

@@ -46,11 +46,12 @@ npm install --save ngx-diff2html
 + @import "~diff2html/dist/diff2html.min.css";
 ```
 
-**3**. Add the following line to `polyfills.ts`:
+**3**. You may also need to add the following lines to `polyfills.ts`:
 
 ```diff
   // Add global to window, assigning the value of window itself.
 + (window as any).global = window;
++ (window as any).process = { env: { DEBUG: undefined } };
 ```
 
 **4**. Start using the component:

package.json

@@ -4,7 +4,8 @@
   "scripts": {
     "ng": "ng",
     "start": "ng serve --project=demo",
-    "build": "ng build ngx-diff2html",
+    "build": "ng build ngx-diff2html && npm run copy:readme",
+    "copy:readme": "cp README.md dist/ngx-diff2html/",
     "build:demo": "ng build demo",
     "build:demo:github": "ng build demo --prod --base-href \"/ngx-diff2html/\"",
     "deploy:demo:github": "ngh --dir=dist/demo",

projects/ngx-diff2html/README.md

@@ -1,88 +1,11 @@
 # NgxDiff2html
 
-[![NPM version](https://img.shields.io/npm/v/ngx-diff2html)](https://www.npmjs.com/package/ngx-diff2html)
-[![Downloads](https://img.shields.io/npm/dt/ngx-diff2html)](https://npmjs.org/package/ngx-diff2html)
-[![License](https://img.shields.io/npm/l/ngx-diff2html)](LICENSE)
+This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.2.14.
 
-A simple text diff component for Angular, based on [diff-match-patch](https://github.com/google/diff-match-patch) & [diff2html](https://github.com/rtfpessoa/diff2html).
+## Code scaffolding
 
-## Demo
-
-[ngx-diff2html Demo](https://axel-dev.github.io/ngx-diff2html)
-
-## Installation
-
-```
-npm install --save ngx-diff2html
-```
-
-## Usage
-
-**1**. Register the `NgxDiff2htmlModule` in a module, for example app module:
-
-```diff
-  import { BrowserModule } from '@angular/platform-browser';
-  import { NgModule } from '@angular/core';
-
-  import { AppComponent } from './app.component';
-+ import { NgxDiff2htmlModule } from 'ngx-diff2html';
-
-  @NgModule({
-    declarations: [AppComponent],
-    imports: [
-      BrowserModule,
-+     NgxDiff2htmlModule
-    ],
-    providers: [],
-    bootstrap: [AppComponent]
-  })
-  export class AppModule {}
-```
-
-**2**. Import diff2html css in `styles.css`:
-
-```diff
-  /* You can add global styles to this file, and also import other style files */
-+ @import "~diff2html/dist/diff2html.min.css";
-```
-
-**3**. Add the following line to `polyfills.ts`:
-
-```diff
-  // Add global to window, assigning the value of window itself.
-+ (window as any).global = window;
-```
-
-**4**. Start using the component:
-
-```html
-<ngx-diff2html
-  left="some text"
-  right="some other text"
-></ngx-diff2html>
-```
-
-## API
-
-- module: `NgxDiff2htmlModule`
-- component: `NgxDiff2htmlComponent`
-- selector: `ngx-diff2html`
-
-### Inputs
-
-| Input                | Type              | Required                             | Description
-| -------------------- | ----------------- | ------------------------------------ | --------------------------
-| left                 | string            | Yes                                  | First text to be compared
-| right                | string            | Yes                                  | Second text to be compared
-| filename             | string            | Optional, default: `` (empty)        | Can be used to display a filename at the top of diff results.
-| format               | `DiffFormat`      | Optional, default: `side-by-side`    | Possible values:<br> - `side-by-side`<br> - `line-by-line`
-| style                | `DiffStyle`       | Optional, default: `word`            | Possible values:<br> - `word`<br> - `char`
-
-### Outputs
-
-| Output               | Type              | Required                             | Description
-| -------------------- | ----------------- | ------------------------------------ | --------------------------
-| diffChange           | string            | Optional                             | Event fired when diff changes. The returned value is the text diff in [unified format](http://fileformats.archiveteam.org/wiki/Unified_diff)
+Run `ng generate component component-name --project ngx-diff2html` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ngx-diff2html`.
+> Note: Don't forget to add `--project ngx-diff2html` or else it will be added to the default project in your `angular.json` file. 
 
 ## Build
 
@@ -92,6 +15,10 @@ Run `ng build ngx-diff2html` to build the project. The build artifacts will be s
 
 After building your library with `ng build ngx-diff2html`, go to the dist folder `cd dist/ngx-diff2html` and run `npm publish`.
 
-## License
+## Running unit tests
+
+Run `ng test ngx-diff2html` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+## Further help
 
-This project is licensed under the [MIT](LICENSE) license.
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).