Skip to content

Commit 8517fda

Browse files
Update README.md
1 parent fe3d8fd commit 8517fda

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,11 @@
44
<a href="https://www.npmjs.com/package/react-scrollama">
55
<img src="https://img.shields.io/npm/v/react-scrollama.svg" alt="npm version"/>
66
</a>
7-
<a href="https://david-dm.org/jsonkao/react-scrollama">
8-
<img src="https://img.shields.io/david/jsonkao/react-scrollama" alt="dependency status"/>
9-
</a>
107
</p>
118

12-
React Scrollama is a lightweight interface for scrollytelling in React. It is adapted from Russel Goldenbeg's [Scrollama](https://github.com/russellgoldenberg/scrollama), and it uses the [IntersectionObserver](https://developer.mozilla.org/docs/Web/API/Intersection_Observer_API) instead of scroll events.
9+
React Scrollama is a simple library for scrollytelling in React, utilizing the IntersectionObserver. It's adapted from [Russel Samora's](https://russellsamora.github.io/) [Scrollama](https://github.com/russellgoldenberg/scrollama).
1310

14-
As seen in:
11+
Some examples:
1512
<table>
1613
<tbody>
1714
<tr>
@@ -54,7 +51,7 @@ As seen in:
5451

5552
## Demo
5653

57-
Take a look at [the live demo](https://jsonkao.github.io/react-scrollama), presented at [ReactNYC](https://www.youtube.com/watch?v=zR_LDPLMUvE).
54+
A live demo [lives here](https://jsonkao.github.io/react-scrollama), presented at [ReactNYC](https://www.youtube.com/watch?v=zR_LDPLMUvE).
5855

5956
<table>
6057
<tr>
@@ -74,11 +71,11 @@ React Scrollama can be installed as an [npm package](https://www.npmjs.com/packa
7471
$ npm install react-scrollama
7572
```
7673

77-
**Note: As of version 2.2.0, the [IntersectionObserver polyfill](https://www.npmjs.com/package/intersection-observer) has been removed from the build. You must include it yourself for cross-browser support.** Check [here](https://caniuse.com/#feat=intersectionobserver) to see if you need to include the polyfill.
74+
**Note: Version 2.2.0 removed the [IntersectionObserver polyfill](https://www.npmjs.com/package/intersection-observer) from the build. If you want [cross-browser support](https://caniuse.com/#feat=intersectionobserver), you should include it yourself.**
7875

7976
## Usage
8077

81-
A `Scrollama` component wraps a set of steps. Each `Step` component [must wrap a DOM element](https://github.com/jsonkao/react-scrollama/issues/19#issuecomment-624861326).
78+
A `Scrollama` component wraps a set of steps. Each `Step` component [must](https://github.com/jsonkao/react-scrollama/issues/19#issuecomment-624861326) wrap a DOM element (i.e. not just text).
8279

8380
```jsx
8481
<Scrollama onStepEnter={callback} offset={0.5}>
@@ -93,7 +90,7 @@ A `Scrollama` component wraps a set of steps. Each `Step` component [must wrap a
9390

9491
`<Scrollama>` provides an interface for listening in on scroll triggers like entering or exiting a step. (Here's [a full list](#scrollama) of available props.)
9592

96-
A no-frills example:
93+
A basic example:
9794

9895
```jsx
9996
import React, { useState } from 'react';
@@ -189,7 +186,7 @@ These are the props you can set on the `Step` component:
189186

190187
You will also probably want to set a `key` prop on each `Step` if you're transforming an array of data into a list of `Step` elements (see [Lists and Keys](https://reactjs.org/docs/lists-and-keys.html)).
191188

192-
## The contributors who made this possible
189+
## Thank you to everyone who made this possible!
193190

194191
* [jsonkao](https://github.com/jsonkao)
195192
* [maerzhase](https://github.com/maerzhase)
@@ -213,4 +210,4 @@ You will also probably want to set a `key` prop on each `Step` if you're transfo
213210
* Currently, there is no way to throttle/customize React Scrollama's [resize listener](https://github.com/jsonkao/react-scrollama/blob/master/src/Scrollama.js#L104) 😢. We're working on this in [#44](https://github.com/jsonkao/react-scrollama/issues/44).
214211
* Fire previous step triggers if they were jumped
215212

216-
If you need these features ASAP, let us know in issue!
213+
Lmk if you need these features ASAP.

0 commit comments

Comments
 (0)