Create README.md

Matiszak · Oct 13, 2017 · 87e4cd6 · 87e4cd6
1 parent 54745d9
commit 87e4cd6
Showing 1 changed file with 40 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,40 @@
+# ngx-password-toggle
+Angular 4+ directive to show/hide password
+
+![](https://img.shields.io/npm/v/ngx-password-toggle.svg?style=flat-square)
+![](https://img.shields.io/npm/dt/ngx-password-toggle.svg?style=flat-square)
+![](https://img.shields.io/github/issues/thatisuday/ngx-password-toggle.svg?style=flat-square)
+![](https://img.shields.io/david/thatisuday/ngx-password-toggle.svg?style=flat-square)
+
+
+## Install
+```
+npm i ngx-password-toggle
+```
+
+## Import
+```
+import { NgxPasswordToggleModule } from 'ngx-password-toggle';
+
+@NgModule({
+  imports: [
+    ...,
+    NgxPasswordToggleModule
+  ]
+})
+export class MyModule(){ }
+```
+
+## Use directive
+use `passwordToggle` directive
+
+![](https://i.imgur.com/RS3X7mB.png)
+
+```
+<!-- Password -->
+<div class="field">
+  <label for="">Password</label>
+  <input type="password" name="password" ngModel passwordToggle required>
+</div>
+```
+