Readme updates

CodyTolene · CodyTolene · commit 3ee342b86cae · 2025-02-09T02:00:50.000-06:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @CodyTolene
diff --git a/.github/images/ng-icons/Angular Material Icons.url b/.github/images/ng-icons/Angular Material Icons.url
@@ -0,0 +1,5 @@
+[{000214A0-0000-0000-C000-000000000046}]
+Prop3=19,11
+[InternetShortcut]
+IDList=
+URL=https://fonts.google.com/icons
diff --git a/.github/images/ng-icons/email.svg b/.github/images/ng-icons/email.svg
@@ -0,0 +1,12 @@
+<svg 
+    xmlns="http://www.w3.org/2000/svg" 
+    height="24" 
+    viewBox="0 -960 960 960" 
+    width="24"
+>
+    <title>Email</title>
+    <path 
+        fill="#8ab4f8"
+        d="M160-160q-33 0-56.5-23.5T80-240v-480q0-33 23.5-56.5T160-800h640q33 0 56.5 23.5T880-720v480q0 33-23.5 56.5T800-160H160Zm320-280L160-640v400h640v-400L480-440Zm0-80 320-200H160l320 200ZM160-640v-80 480-400Z"
+    />
+</svg>
diff --git a/.github/images/ng-icons/info.svg b/.github/images/ng-icons/info.svg
@@ -0,0 +1,15 @@
+<svg 
+  aria-hidden="true"
+  height="16" 
+  version="1.1" 
+  viewBox="0 -8 16 24" 
+  width="16" 
+  xmlns:xlink="http://www.w3.org/1999/xlink" 
+  xmlns="http://www.w3.org/2000/svg" 
+>
+  <path
+    d="M8 1.5a6.5 6.5 0 100 13 6.5 6.5 0 000-13zM0 8a8 8 0 1116 0A8 8 0 010 8zm6.5-.25A.75.75 0 017.25 7h1a.75.75 0 01.75.75v2.75h.25a.75.75 0 010 1.5h-2a.75.75 0 010-1.5h.25v-2h-.25a.75.75 0 01-.75-.75zM8 6a1 1 0 100-2 1 1 0 000 2z"
+    fill-rule="evenodd"
+    fill="#71B7FF"
+  ></path>
+</svg>
diff --git a/.github/images/ng-icons/warn.svg b/.github/images/ng-icons/warn.svg
@@ -0,0 +1,15 @@
+<svg 
+  aria-hidden="true"
+  height="16" 
+  version="1.1" 
+  viewBox="0 -8 16 24" 
+  width="16" 
+  xmlns:xlink="http://www.w3.org/1999/xlink" 
+  xmlns="http://www.w3.org/2000/svg" 
+>
+  <path
+    d="M8.22 1.754a.25.25 0 00-.44 0L1.698 13.132a.25.25 0 00.22.368h12.164a.25.25 0 00.22-.368L8.22 1.754zm-1.763-.707c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0114.082 15H1.918a1.75 1.75 0 01-1.543-2.575L6.457 1.047zM9 11a1 1 0 11-2 0 1 1 0 012 0zm-.25-5.25a.75.75 0 00-1.5 0v2.5a.75.75 0 001.5 0v-2.5z"
+    fill-rule="evenodd"
+    fill="#F0B72F"
+  ></path>
+</svg>
diff --git a/.github/images/screenshots/.gitkeep b/.github/images/screenshots/.gitkeep
diff --git a/.github/images/simple-icons/Simple Icons.url b/.github/images/simple-icons/Simple Icons.url
@@ -0,0 +1,2 @@
+[InternetShortcut]
+URL=https://github.com/simple-icons
diff --git a/.github/images/simple-icons/bitcoin-btc-logo.svg b/.github/images/simple-icons/bitcoin-btc-logo.svg
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Creator: CorelDRAW 2019 (64-Bit) -->
+<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="100%" height="100%" version="1.1" shape-rendering="geometricPrecision" text-rendering="geometricPrecision" image-rendering="optimizeQuality" fill-rule="evenodd" clip-rule="evenodd"
+viewBox="0 0 4091.27 4091.73"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xodm="http://www.corel.com/coreldraw/odm/2003">
+ <g id="Layer_x0020_1">
+  <metadata id="CorelCorpID_0Corel-Layer"/>
+  <g id="_1421344023328">
+   <path fill="#F7931A" fill-rule="nonzero" d="M4030.06 2540.77c-273.24,1096.01 -1383.32,1763.02 -2479.46,1489.71 -1095.68,-273.24 -1762.69,-1383.39 -1489.33,-2479.31 273.12,-1096.13 1383.2,-1763.19 2479,-1489.95 1096.06,273.24 1763.03,1383.51 1489.76,2479.57l0.02 -0.02z"/>
+   <path fill="white" fill-rule="nonzero" d="M2947.77 1754.38c40.72,-272.26 -166.56,-418.61 -450,-516.24l91.95 -368.8 -224.5 -55.94 -89.51 359.09c-59.02,-14.72 -119.63,-28.59 -179.87,-42.34l90.16 -361.46 -224.36 -55.94 -92 368.68c-48.84,-11.12 -96.81,-22.11 -143.35,-33.69l0.26 -1.16 -309.59 -77.31 -59.72 239.78c0,0 166.56,38.18 163.05,40.53 90.91,22.69 107.35,82.87 104.62,130.57l-104.74 420.15c6.26,1.59 14.38,3.89 23.34,7.49 -7.49,-1.86 -15.46,-3.89 -23.73,-5.87l-146.81 588.57c-11.11,27.62 -39.31,69.07 -102.87,53.33 2.25,3.26 -163.17,-40.72 -163.17,-40.72l-111.46 256.98 292.15 72.83c54.35,13.63 107.61,27.89 160.06,41.3l-92.9 373.03 224.24 55.94 92 -369.07c61.26,16.63 120.71,31.97 178.91,46.43l-91.69 367.33 224.51 55.94 92.89 -372.33c382.82,72.45 670.67,43.24 791.83,-303.02 97.63,-278.78 -4.86,-439.58 -206.26,-544.44 146.69,-33.83 257.18,-130.31 286.64,-329.61l-0.07 -0.05zm-512.93 719.26c-69.38,278.78 -538.76,128.08 -690.94,90.29l123.28 -494.2c152.17,37.99 640.17,113.17 567.67,403.91zm69.43 -723.3c-63.29,253.58 -453.96,124.75 -580.69,93.16l111.77 -448.21c126.73,31.59 534.85,90.55 468.94,355.05l-0.02 0z"/>
+  </g>
+ </g>
+</svg>
diff --git a/.github/images/simple-icons/buymeacoffee.svg b/.github/images/simple-icons/buymeacoffee.svg
@@ -0,0 +1 @@
+<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Buy Me A Coffee</title><path fill="#FFDD00" d="M20.216 6.415l-.132-.666c-.119-.598-.388-1.163-1.001-1.379-.197-.069-.42-.098-.57-.241-.152-.143-.196-.366-.231-.572-.065-.378-.125-.756-.192-1.133-.057-.325-.102-.69-.25-.987-.195-.4-.597-.634-.996-.788a5.723 5.723 0 00-.626-.194c-1-.263-2.05-.36-3.077-.416a25.834 25.834 0 00-3.7.062c-.915.083-1.88.184-2.75.5-.318.116-.646.256-.888.501-.297.302-.393.77-.177 1.146.154.267.415.456.692.58.36.162.737.284 1.123.366 1.075.238 2.189.331 3.287.37 1.218.05 2.437.01 3.65-.118.299-.033.598-.073.896-.119.352-.054.578-.513.474-.834-.124-.383-.457-.531-.834-.473-.466.074-.96.108-1.382.146-1.177.08-2.358.082-3.536.006a22.228 22.228 0 01-1.157-.107c-.086-.01-.18-.025-.258-.036-.243-.036-.484-.08-.724-.13-.111-.027-.111-.185 0-.212h.005c.277-.06.557-.108.838-.147h.002c.131-.009.263-.032.394-.048a25.076 25.076 0 013.426-.12c.674.019 1.347.067 2.017.144l.228.031c.267.04.533.088.798.145.392.085.895.113 1.07.542.055.137.08.288.111.431l.319 1.484a.237.237 0 01-.199.284h-.003c-.037.006-.075.01-.112.015a36.704 36.704 0 01-4.743.295 37.059 37.059 0 01-4.699-.304c-.14-.017-.293-.042-.417-.06-.326-.048-.649-.108-.973-.161-.393-.065-.768-.032-1.123.161-.29.16-.527.404-.675.701-.154.316-.199.66-.267 1-.069.34-.176.707-.135 1.056.087.753.613 1.365 1.37 1.502a39.69 39.69 0 0011.343.376.483.483 0 01.535.53l-.071.697-1.018 9.907c-.041.41-.047.832-.125 1.237-.122.637-.553 1.028-1.182 1.171-.577.131-1.165.2-1.756.205-.656.004-1.31-.025-1.966-.022-.699.004-1.556-.06-2.095-.58-.475-.458-.54-1.174-.605-1.793l-.731-7.013-.322-3.094c-.037-.351-.286-.695-.678-.678-.336.015-.718.3-.678.679l.228 2.185.949 9.112c.147 1.344 1.174 2.068 2.446 2.272.742.12 1.503.144 2.257.156.966.016 1.942.053 2.892-.122 1.408-.258 2.465-1.198 2.616-2.657.34-3.332.683-6.663 1.024-9.995l.215-2.087a.484.484 0 01.39-.426c.402-.078.787-.212 1.074-.518.455-.488.546-1.124.385-1.766zm-1.478.772c-.145.137-.363.201-.578.233-2.416.359-4.866.54-7.308.46-1.748-.06-3.477-.254-5.207-.498-.17-.024-.353-.055-.47-.18-.22-.236-.111-.71-.054-.995.052-.26.152-.609.463-.646.484-.057 1.046.148 1.526.22.577.088 1.156.159 1.737.212 2.48.226 5.002.19 7.472-.14.45-.06.899-.13 1.345-.21.399-.072.84-.206 1.08.206.166.281.188.657.162.974a.544.544 0 01-.169.364zm-6.159 3.9c-.862.37-1.84.788-3.109.788a5.884 5.884 0 01-1.569-.217l.877 9.004c.065.78.717 1.38 1.5 1.38 0 0 1.243.065 1.658.065.447 0 1.786-.065 1.786-.065.783 0 1.434-.6 1.499-1.38l.94-9.95a3.996 3.996 0 00-1.322-.238c-.826 0-1.491.284-2.26.613z"/></svg>
diff --git a/.github/images/simple-icons/github.svg b/.github/images/simple-icons/github.svg
@@ -0,0 +1 @@
+<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>GitHub</title><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://www.ProAngular.com" target="_blank">
-    <img src="public/pro-angular-logo.png" />
+    <img src="public/images/pro-angular-logo.png" />
   </a>
   <h1 align="center">
     <a href="https://www.ProAngular.com" target="_blank">
@@ -30,34 +30,58 @@
 - [Description](#description)
 - [Demo](#demo)
 - [Installation](#installation)
-- [Dependencies](#dependencies)
+  - [Prerequisites](#prerequisites)
+  - [Install Scroll Top Component](#install-scroll-top-component)
 - [Usage](#usage)
 - [Component API](#api)
 - [Compatibility](#compatibility)
 - [Issues & Contribution](#development)
 - [Donations](#donations)
-- [License](#license)
+- [Licensing](#licensing)
+- [Wrapping Up](#wrapping-up)
 
-<a name="description"/>
-
-## Description
+## Description <a name="description"></a>
 
 Configurable, lightweight back to top button for Angular projects.
 
-<a name="demo"/>
+<p align="right">[ <a href="#index">Index</a> ]</p>
+
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
 
-## Demo
+## Demo <a name="demo"></a>
 
 <p align="center">
-  <img src="public/demo-scroll-top.gif" />
+  <img src="public/images/demo-scroll-top.gif" />
 </p>
 
 Live demo here:
 [https://www.ProAngular.com/demos/ngx-scroll-top](https://www.ProAngular.com/demos/ngx-scroll-top)
 
-<a name="installation"/>
+<p align="right">[ <a href="#index">Index</a> ]</p>
+
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+
+## Installation <a name="installation"></a>
+
+Using Node Package Manager ([NPM][url-node-js]) in a new terminal window run the
+following commands to install the required dependencies.
+
+### Prerequisites <a name="prerequisites"></a>
+
+**Angular Material**
 
-## Installation
+More information on theming Angular Material:
+https://material.angular.io/guide/theming
+
+```bash
+ng add @angular/material
+```
+
+### Install Scroll Top Component <a name="install-scroll-top-component"></a>
 
 ```bash
 ng add @proangular/ngx-scroll-top@latest
@@ -69,47 +93,13 @@ or
 npm install @proangular/ngx-scroll-top --save
 ```
 
-Import `NgxScrollTopComponent` where needed
-
-```diff
-+ import { NgxScrollTopComponent } from '@proangular/ngx-scroll-top';
-
-// Import to module
-@NgModule({
-  ...
-  imports: [
-+   NgxScrollTopComponent,
-    ...
-  ],
-})
-
-...
-
-// or component
-@Component({
-  ...
-  imports: [
-+   NgxScrollTopComponent,
-    ...
-  ],
-})
-```
-
-<a name="dependencies"/>
-
-## Dependencies
-
-### Styling UX - Angular Material
-
-You should have an Angular Material theme set up prior to using this. It's also
-possible to use this without an angular theme and style it yourself entirely!
-
-More information on theming Angular Material:
-https://material.angular.io/guide/theming
+<p align="right">[ <a href="#index">Index</a> ]</p>
 
-<a name="usage"/>
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
 
-## Usage
+## Usage <a name="usage"></a>
 
 Default (blue button with white icon)
 
@@ -134,9 +124,13 @@ Customization with optional inputs and icon
 >
 ```
 
-<a name="api"/>
+<p align="right">[ <a href="#index">Index</a> ]</p>
 
-## Component API
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+
+## Component API <a name="api"></a>
 
 | Input                  | Value Typing          | Default Value           | Description                                                                                                                                        |
 | ---------------------- | --------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -150,9 +144,13 @@ Customization with optional inputs and icon
 | **width**              | string                | `'40px'`                | Width of back to top button in string px format.                                                                                                   |
 | **zIndex**             | number                | `999`                   | Style the `z-index` for the back to top button as needed for correct layer height adjustment. This can be useful when working with sticky headers. |
 
-<a name="compatibility"/>
+<p align="right">[ <a href="#index">Index</a> ]</p>
+
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
 
-## Compatibility
+## Compatibility <a name="compatibility"></a>
 
 | Angular version | @proangular/ngx-scroll-top | Status     |
 | --------------- | -------------------------- | ---------- |
@@ -165,9 +163,13 @@ Customization with optional inputs and icon
 | v13             | v1.x.x                     | Compatible |
 | v12             | v1.x.x                     | Compatible |
 
-<a name="development"/>
+<p align="right">[ <a href="#index">Index</a> ]</p>
 
-## Issues & Contribution
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+
+## Issues & Contribution <a name="development"></a>
 
 Please submit all issues, and feature requests here:
 [https://github.com/ProAngular/ngx-scroll-top/issues](https://github.com/ProAngular/ngx-scroll-top/issues)
@@ -196,22 +198,41 @@ Contribution:
 
 Thank you for any and all contributions!
 
-<a name="donations"/>
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+
+## Licensing <a name="licensing"></a>
+
+This project is licensed under the **MIT** License. See the
+[LICENSE](LICENSE.md) file for the pertaining license text.
+
+`SPDX-License-Identifier: MIT`
+
+<p align="right">[ <a href="#index">Index</a> ]</p>
 
-## Donation
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
+<!---------------------------------------------------------------------------->
 
-As a husband and father of four children, your donations mean the world to me!
-Any donations are greatly appreciated and keep me going!
+## Wrapping Up <a name="wrapping-up"></a>
 
-- [https://www.paypal.me/CodyTolene](https://www.paypal.me/CodyTolene)
-- [https://github.com/sponsors/ProAngular](https://github.com/sponsors/ProAngular)
+Thank you to the entire Angular team and community for such a great framework to
+build upon. If you have any questions, please let me know by opening an issue
+[here][url-new-issue].
 
-<a name="license"/>
+| Type                                                                      | Info                                                           |
+| :------------------------------------------------------------------------ | :------------------------------------------------------------- |
+| <img width="48" src=".github/images/ng-icons/email.svg" />                | webmaster@codytolene.com                                       |
+| <img width="48" src=".github/images/simple-icons/github.svg" />           | https://github.com/sponsors/CodyTolene                         |
+| <img width="48" src=".github/images/simple-icons/buymeacoffee.svg" />     | https://www.buymeacoffee.com/codytolene                        |
+| <img width="48" src=".github/images/simple-icons/bitcoin-btc-logo.svg" /> | bc1qfx3lvspkj0q077u3gnrnxqkqwyvcku2nml86wmudy7yf2u8edmqq0a5vnt |
 
-## License
+Fin. Happy programming friend!
 
-Copyright &copy; 2022 [Cody Tolene](https://www.CodyTolene.com)
+Cody Tolene
 
-All content is licensed under the [MIT license].
+<!-- LINKS -->
 
-[mit license]: LICENSE
+[url-new-issue]: https://github.com/ProAngular/ngx-scroll-top/issues
+[url-node-js]: https://nodejs.org/

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[InternetShortcut]`
	`2`	`+URL=https://github.com/simple-icons`