From 9f243bad7430131a5ca30f87da5d41007185d0c5 Mon Sep 17 00:00:00 2001
From: Cody Tolene
Date: Thu, 28 Jul 2022 17:33:47 -0500
Subject: [PATCH] Documentation updates
---
README.md | 44 ++++++++++++++++++--------------------------
package-lock.json | 2 +-
package.json | 2 +-
3 files changed, 20 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
index 9591057..b786d22 100644
--- a/README.md
+++ b/README.md
@@ -25,29 +25,17 @@ Configurable, lightweight back to top button for Angular projects.
-To run this demo:
-* `git clone https://github.com/ProAngular/ngx-scroll-top.git`
-* `cd ngx-scroll-top`
-* `npm install`
-* `npm run start`
+# Installation
-# Installation and importing
-
-## Installation
-
-Angular
```bash
ng add @proangular/ngx-scroll-top@latest
```
-
-Direct
+or
```bash
npm install @proangular/ngx-scroll-top --save
```
-## Import
-
-Import package into the module of your choice
+Import `NgxScrollTopModule` where needed
```diff
...
+ import { NgxScrollTopModule } from '@proangular/ngx-scroll-top';
@@ -63,14 +51,14 @@ Import package into the module of your choice
export class AppModule { }
```
-# Usage and Examples
+# Usage
-Default use (blue button with white icon)
+Default (blue button with white icon)
```html
```
-Example with optional inputs
+Customization with optional inputs and icon
```html
",
"homepage": "https://www.proangular.com",