diff --git a/README.md b/README.md index e8df204..abdcbf0 100644 --- a/README.md +++ b/README.md @@ -19,14 +19,6 @@ Configurable, lightweight back to top button for Angular projects. -# Compatibility - -| Angular version | @proangular/ngx-scroll-top | Install | -| --------------- | -------------------------- | ------------------------------------------ | -| v14 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` | -| v13 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` | -| v12 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` | - # Demo
@@ -89,12 +81,36 @@ Use package
```
+# Compatibility
+
+| Angular version | @proangular/ngx-scroll-top | Install |
+| --------------- | -------------------------- | ------------------------------------------ |
+| v14 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
+| v13 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
+| v12 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
+
# Development
-1. Pull, create new branch, add changes.
+1. Clone, create new branch.
+
+`git clone https://github.com/ProAngular/ngx-scroll-top.git`
+
+`git checkout -b username/feature`
+
2. Bump version of package in `package.json` and `package-lock.json`, commit all changes, push.
-3. Submit code in published PR for review and approval.
+
+`git add -A`
+
+`git commit -m "My commit message"`
+
+`git push origin username/feature`
+
+3. Submit code in published PR for review and approval. Add a good description and link any possible user stories or bugs.
+
+[Create a new pull request](https://github.com/ProAngular/ngx-scroll-top/compare).
+
4. Allow CI actions to completely run and verify files.
+5. Add/ping reviewers and await approval.
Thank you for your contributions!
@@ -103,12 +119,13 @@ Thank you for your contributions!
As a husband and father of four children, your donations mean the world to me! Any donations are greatly appreciated and keep me going!
[https://www.paypal.me/CodyTolene](https://www.paypal.me/CodyTolene)
+
[https://github.com/sponsors/ProAngular](https://github.com/sponsors/ProAngular)
# License
Copyright © 2022 [Cody Tolene](https://www.CodyTolene.com)
-All contents are licensed under the [MIT license].
+All content is licensed under the [MIT license].
[mit license]: LICENSE
diff --git a/package-lock.json b/package-lock.json
index 58adf9a..93d309d 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "@proangular/ngx-scroll-top",
- "version": "1.1.3",
+ "version": "1.1.4",
"lockfileVersion": 2,
"requires": true,
"packages": {
diff --git a/package.json b/package.json
index b764dcd..06bf3d3 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@proangular/ngx-scroll-top",
- "version": "1.1.3",
+ "version": "1.1.4",
"description": "Configurable, lightweight back to top button for Angular projects.",
"author": "Pro Angular