Skip to content

Commit d613c4a

Browse files
committed
docs: update intro
1 parent b87429b commit d613c4a

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

documentation/docs/intro.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,42 @@
11
---
2+
sidebar_label: Intro
23
sidebar_position: 1
34
---
45

56
# React Scroll Parallax
67

78
[![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)
89

9-
React hooks and components to create parallax scroll effects for banners, images or any other DOM elements. Utilizes [Parallax Controller](https://github.com/jscottsmith/parallax-controller) to add vertical or horizontal scrolling based effects to elements. [Optimized](https://parallax-controller.vercel.app/docs/performance) to _reduce_ jank on scroll and works with SSR and SSG rendered React apps.
10+
React hooks and components to create parallax scroll effects for banners, images or any other DOM elements. Utilizes [Parallax Controller](https://parallax-controller.v1.damnthat.tv) to add vertical or horizontal scrolling based effects to elements. [Optimized](https://parallax-controller.v1.damnthat.tv/docs/performance) to _reduce_ jank on scroll and works with SSR and SSG rendered React apps.
1011

1112
If you're coming from [V2](https://github.com/jscottsmith/react-scroll-parallax/tree/v2.4.2), here's a [migration guide](/docs/migration-guides/v2-migration-guide).
13+
14+
## Install (v3 beta)
15+
16+
With npm
17+
18+
```
19+
npm i react-scroll-parallax@beta --save
20+
```
21+
22+
or yarn
23+
24+
```
25+
yarn add react-scroll-parallax@beta
26+
```
27+
28+
## Getting Started
29+
30+
- [Usage](/docs/usage/)
31+
32+
### Docs: Components
33+
34+
- [`<Parallax>`](/docs/usage/components/parallax-component)
35+
- [`<ParallaxBanner>`](/docs/usage/components/parallax-banner-component)
36+
- [`<ParallaxProvider>`](/docs/usage/components/parallax-provider)
37+
38+
### Docs: Hooks
39+
40+
- [`useParallax()`](/docs/usage/components/use-parallax-hook.md)
41+
- [`useController()`](/#todo)
42+
- [`useParallaxImage`](/#todo)

documentation/docs/migration-guides/v2-migration-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
With mostly just new features, V3 also makes a few breaking changes. See the following and migrate any code that is affected.
44

5-
### Renamed Props for <Parallax\>
5+
### Prop changes for <Parallax\>
66

77
If you've used any of the following props simply rename to new ones or refactor if if they are no longer supported.
88

0 commit comments

Comments
 (0)