Skip to content

Commit 3e45bae

Browse files
committed
update README
1 parent 766d7ba commit 3e45bae

File tree

2 files changed

+6
-24
lines changed

2 files changed

+6
-24
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![npm version](https://badge.fury.io/js/react-scroll-parallax.svg)](https://badge.fury.io/js/react-scroll-parallax) [![Build Status](https://travis-ci.org/jscottsmith/react-scroll-parallax.svg?branch=master)](https://travis-ci.org/jscottsmith/react-scroll-parallax) [![codecov](https://codecov.io/gh/jscottsmith/react-scroll-parallax/branch/master/graph/badge.svg)](https://codecov.io/gh/jscottsmith/react-scroll-parallax)
44

5-
React components to create parallax scroll effects for banners, images or any other DOM elements. Uses a single scroll listener to add vertical or horizontal scrolling based offsets to elements based on their position in the viewport. [Optimized](#optimizations-to-reduce-jank) to _reduce_ jank on scroll and works with universal (server-side rendered) React apps.
5+
React components to create parallax scroll effects for banners, images or any other DOM elements. Uses a single scroll listener via [Parallax Controller](https://github.com/jscottsmith/parallax-controller) to add vertical or horizontal scrolling based offsets to elements based on their position in the viewport. [Optimized](https://github.com/jscottsmith/parallax-controller#optimizations-to-reduce-jank) to _reduce_ jank on scroll and works with universal (server-side rendered) React apps.
66

77
If you're coming from [v1](https://github.com/jscottsmith/react-scroll-parallax/tree/v1), here's a [migration guide](https://github.com/jscottsmith/react-scroll-parallax/blob/master/docs/migration-guide.md).
88

@@ -100,7 +100,7 @@ React scroll parallax should support the last two versions of all major browsers
100100

101101
## Optimizations to Reduce Jank
102102

103-
React Scroll Parallax uses a single [passive scroll listener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#Improving_scrolling_performance_with_passive_listeners) (dependent on browser support) with the minimal amount of work done on the scroll event to prevent [jank](http://jankfree.org/) (calculations that cause layout, reflow and paint are cached initially and only updated when layout changes). Request animation frame is then used to decouple the scroll handler and further reduce jank. All offsets are applied with 3D transforms to utilize the GPU and prevent paints. If you have ideas to further optimize scrolling please PR or post an issue.
103+
Considerations to reduce have been taken to reduce jank. [Please read more here](https://github.com/jscottsmith/parallax-controller#optimizations-to-reduce-jank) on how this is done
104104

105105
### **PSA**
106106

docs/development.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,36 +24,18 @@ Run Jest tests
2424
yarn test
2525
```
2626

27-
## Linting and Prettier
27+
## Prettier
2828

2929
Run prettier on source files
3030

3131
```
3232
yarn prettier
3333
```
3434

35-
Lint files with eslint
36-
37-
```
38-
yarn lint
39-
```
40-
4135
## Publishing New Version to NPM
4236

43-
Bump the version with npm to commit package.json update and tag release.
44-
45-
```
46-
npm version 2.0.0-beta.0
47-
```
37+
Use `np`
4838

49-
Add any additional tags to npm if applicable
50-
51-
```
52-
npm dist-tag add react-scroll-parallax@2.0.0-beta.0 next
53-
```
54-
55-
Publish to npm
56-
57-
```
58-
npm publish --tag beta
39+
```bash
40+
npx np
5941
```

0 commit comments

Comments
 (0)