Skip to content

Commit

Permalink
Installation section
Browse files Browse the repository at this point in the history
  • Loading branch information
gdbroman committed Aug 5, 2024
1 parent 529d781 commit 2140906
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,27 @@

<br/>

## Introduction
## Why React Promenade?

*React Promenade boosts completion rates by breaking big forms into multi-step user flows.*
Breaking big forms into multi-step user flows will almost always:

**View full documentation and examples under [./docs](./docs)**.
* **improve UX**
* **increase user engagement**
* **boost signups & completion rates**

React Promenade is an unstyled component library that makes it easy to create multi-step user flows with step-by-step validation and navigation.

## Installation

```bash
npm i react-promenade
# or
pnpm add react-promenade
# or
yarn add react-promenade
# or
bun add react-promenade
```

## Quick Start

Expand Down Expand Up @@ -68,6 +84,8 @@ function EmailStep() {
}
```

**View full documentation and examples under [./docs](./docs)**.

## Author

* Gus [@gdbroman](https://x.com/gdbroman) (reach out for questions or feedback)

0 comments on commit 2140906

Please sign in to comment.