Skip to content

Commit 7bde642

Browse files
authored
Merge pull request #3 from ProAngular/ct/further-doc-updates
Ct/further doc updates
2 parents b36e150 + efbb926 commit 7bde642

File tree

3 files changed

+30
-13
lines changed

3 files changed

+30
-13
lines changed

README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,6 @@
1919

2020
Configurable, lightweight back to top button for Angular projects.
2121

22-
# Compatibility
23-
24-
| Angular version | @proangular/ngx-scroll-top | Install |
25-
| --------------- | -------------------------- | ------------------------------------------ |
26-
| v14 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
27-
| v13 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
28-
| v12 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
29-
3022
# Demo
3123

3224
<p align="center">
@@ -89,12 +81,36 @@ Use package
8981
</ngx-scroll-top>
9082
```
9183

84+
# Compatibility
85+
86+
| Angular version | @proangular/ngx-scroll-top | Install |
87+
| --------------- | -------------------------- | ------------------------------------------ |
88+
| v14 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
89+
| v13 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
90+
| v12 | v1.x.x | `ng add @proangular/ngx-scroll-top@latest` |
91+
9292
# Development
9393

94-
1. Pull, create new branch, add changes.
94+
1. Clone, create new branch.
95+
96+
`git clone https://github.com/ProAngular/ngx-scroll-top.git`
97+
98+
`git checkout -b username/feature`
99+
95100
2. Bump version of package in `package.json` and `package-lock.json`, commit all changes, push.
96-
3. Submit code in published PR for review and approval.
101+
102+
`git add -A`
103+
104+
`git commit -m "My commit message"`
105+
106+
`git push origin username/feature`
107+
108+
3. Submit code in published PR for review and approval. Add a good description and link any possible user stories or bugs.
109+
110+
[Create a new pull request](https://github.com/ProAngular/ngx-scroll-top/compare).
111+
97112
4. Allow CI actions to completely run and verify files.
113+
5. Add/ping reviewers and await approval.
98114

99115
Thank you for your contributions!
100116

@@ -103,12 +119,13 @@ Thank you for your contributions!
103119
As a husband and father of four children, your donations mean the world to me! Any donations are greatly appreciated and keep me going!
104120

105121
[https://www.paypal.me/CodyTolene](https://www.paypal.me/CodyTolene)
122+
106123
[https://github.com/sponsors/ProAngular](https://github.com/sponsors/ProAngular)
107124

108125
# License
109126

110127
Copyright &copy; 2022 [Cody Tolene](https://www.CodyTolene.com)
111128

112-
All contents are licensed under the [MIT license].
129+
All content is licensed under the [MIT license].
113130

114131
[mit license]: LICENSE

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@proangular/ngx-scroll-top",
3-
"version": "1.1.3",
3+
"version": "1.1.4",
44
"description": "Configurable, lightweight back to top button for Angular projects.",
55
"author": "Pro Angular <[email protected]>",
66
"homepage": "https://www.proangular.com",

0 commit comments

Comments
 (0)