Skip to content

Documentation updates #5

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 1 commit into from
Jul 28, 2022
Merged

Documentation updates #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 18 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,29 +25,17 @@ Configurable, lightweight back to top button for Angular projects.
<img src="src/assets/images/demo-scroll-top.gif" />
</p>

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';
Expand All @@ -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
<ngx-scroll-top></ngx-scroll-top>
```

Example with optional inputs
Customization with optional inputs and icon
```html
<ngx-scroll-top
backgroundColor="#0D58C0"
Expand Down Expand Up @@ -109,15 +97,19 @@ Example with optional inputs

# Development

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.
* `git add -A`
* `git commit -m "My commit message"`
* `git push origin username/feature`
Please submit all issues, and feature requests here: [https://github.com/ProAngular/ngx-scroll-top/issues](https://github.com/ProAngular/ngx-scroll-top/issues)

Contribution:

1. Clone the repo and create a new branch:
* `git clone https://github.com/ProAngular/ngx-scroll-top.git`
* `git checkout -b username/feature-or-bug-description`
2. Bump up the version of package in `package.json` and `package-lock.json`, commit all changes, push.
* `git add -A`
* `git commit -m "My commit message"`
* `git push origin username/feature-or-bug-description`
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).
* [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.

Expand Down
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.5",
"version": "1.1.6",
"description": "Configurable, lightweight back to top button for Angular projects.",
"author": "Pro Angular <[email protected]>",
"homepage": "https://www.proangular.com",
Expand Down