Skip to content

Commit 2f3ba2c

Browse files
committed
docs: update intro
1 parent d84b5c0 commit 2f3ba2c

File tree

1 file changed

+4
-28
lines changed

1 file changed

+4
-28
lines changed

documentation/docs/intro.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,10 @@
22
sidebar_position: 1
33
---
44

5-
# Tutorial Intro
5+
# React Scroll Parallax
66

7-
Let's discover **Docusaurus in less than 5 minutes**.
7+
[![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)
88

9-
## Getting Started
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.
1010

11-
Get started by **creating a new site**.
12-
13-
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
14-
15-
## Generate a new site
16-
17-
Generate a new Docusaurus site using the **classic template**:
18-
19-
```shell
20-
npm init docusaurus@latest my-website classic
21-
```
22-
23-
## Start your site
24-
25-
Run the development server:
26-
27-
```shell
28-
cd my-website
29-
30-
npx docusaurus start
31-
```
32-
33-
Your site starts at `http://localhost:3000`.
34-
35-
Open `docs/intro.md` and edit some lines: the site **reloads automatically** and displays your changes.
11+
If you're coming from [V2](https://github.com/jscottsmith/react-scroll-parallax/tree/v2.4.2), here's a [migration guide](https://github.com/jscottsmith/react-scroll-parallax/blob/master/docs/migration-guide.md).

0 commit comments

Comments
 (0)