Skip to content

Commit 3591b07

Browse files
authored
Merge pull request #5 from ProAngular/ct/more-doc-updates
Documentation updates
2 parents 618735a + 9f243ba commit 3591b07

File tree

3 files changed

+20
-28
lines changed

3 files changed

+20
-28
lines changed

README.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -25,29 +25,17 @@ Configurable, lightweight back to top button for Angular projects.
2525
<img src="src/assets/images/demo-scroll-top.gif" />
2626
</p>
2727

28-
To run this demo:
29-
* `git clone https://github.com/ProAngular/ngx-scroll-top.git`
30-
* `cd ngx-scroll-top`
31-
* `npm install`
32-
* `npm run start`
28+
# Installation
3329

34-
# Installation and importing
35-
36-
## Installation
37-
38-
Angular
3930
```bash
4031
ng add @proangular/ngx-scroll-top@latest
4132
```
42-
43-
Direct
33+
or
4434
```bash
4535
npm install @proangular/ngx-scroll-top --save
4636
```
4737

48-
## Import
49-
50-
Import package into the module of your choice
38+
Import `NgxScrollTopModule` where needed
5139
```diff
5240
...
5341
+ import { NgxScrollTopModule } from '@proangular/ngx-scroll-top';
@@ -63,14 +51,14 @@ Import package into the module of your choice
6351
export class AppModule { }
6452
```
6553

66-
# Usage and Examples
54+
# Usage
6755

68-
Default use (blue button with white icon)
56+
Default (blue button with white icon)
6957
```html
7058
<ngx-scroll-top></ngx-scroll-top>
7159
```
7260

73-
Example with optional inputs
61+
Customization with optional inputs and icon
7462
```html
7563
<ngx-scroll-top
7664
backgroundColor="#0D58C0"
@@ -109,15 +97,19 @@ Example with optional inputs
10997

11098
# Development
11199

112-
1. Clone, create new branch.
113-
* `git clone https://github.com/ProAngular/ngx-scroll-top.git`
114-
* `git checkout -b username/feature`
115-
2. Bump version of package in `package.json` and `package-lock.json`, commit all changes, push.
116-
* `git add -A`
117-
* `git commit -m "My commit message"`
118-
* `git push origin username/feature`
100+
Please submit all issues, and feature requests here: [https://github.com/ProAngular/ngx-scroll-top/issues](https://github.com/ProAngular/ngx-scroll-top/issues)
101+
102+
Contribution:
103+
104+
1. Clone the repo and create a new branch:
105+
* `git clone https://github.com/ProAngular/ngx-scroll-top.git`
106+
* `git checkout -b username/feature-or-bug-description`
107+
2. Bump up the version of package in `package.json` and `package-lock.json`, commit all changes, push.
108+
* `git add -A`
109+
* `git commit -m "My commit message"`
110+
* `git push origin username/feature-or-bug-description`
119111
3. Submit code in published PR for review and approval. Add a good description and link any possible user stories or bugs.
120-
* [Create a new pull request](https://github.com/ProAngular/ngx-scroll-top/compare).
112+
* [Create a new pull request](https://github.com/ProAngular/ngx-scroll-top/compare).
121113
4. Allow CI actions to completely run and verify files.
122114
5. Add/ping reviewers and await approval.
123115

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.5",
3+
"version": "1.1.6",
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)