Skip to content

Ct/further doc updates #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 28, 2022
Merged

Ct/further doc updates #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c55a3f
Quick updates to documentation
CodyTolene Jul 28, 2022
64d5394
Quick code examples
CodyTolene Jul 28, 2022
efbb926
Add spacing
CodyTolene Jul 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 28 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<p align="center">
Expand Down Expand Up @@ -89,12 +81,36 @@ Use package
</ngx-scroll-top>
```

# 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!

Expand All @@ -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 &copy; 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
2 changes: 1 addition & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <webmaster@proangular.com>",
"homepage": "https://www.proangular.com",
Expand Down