Add docs about NgModule

dzonatan · Sep 14, 2016 · 508f01d · 508f01d
1 parent aa1b222
commit 508f01d
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,20 @@ This is just a wrapper for [Autolinker.js](https://github.com/gregjacobs/Autolin
 ## Installation
 `npm install --save angular2-linky`
 
+Import `LinkyModule` or manually declare `LinkyPipe` in your app module.
+```ts
+import { LinkyModule } from 'angular2-linky';
+
+@NgModule({
+  imports: [
+    LinkyModule
+  ]
+})
+class YourAppModule {}
+```
+
 ## Usage
+
 Use **linky** pipe with **[innerHTML]** (or outerHTML, depends on you) binding to get HTML correctly rendered:
 
 `<span [innerHTML]="yourText | linky"></span>`