Skip to content

Commit

Permalink
🚧 Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
XionWCFM committed Aug 11, 2024
1 parent 75d2a68 commit a50e3aa
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,30 @@ Many frameworks provide routers to change paths. Supporting all of this would be

We aim for code that allows you to see at a glance how the funnel should behave.

# Supported

Currently officially supported are `next.js app router`, `next.js pages router`, `react-router-dom`.

# Installation

**nextjs app router**

```
npm i qs @xionhub/funnel-core @xionhub/funnel-client @xionhub/funnel-app-router-adapter
```

**nextjs pages router**

```
npm i qs @xionhub/funnel-core @xionhub/funnel-client @xionhub/funnel-pages-router-adapter
```

**react-router-dom**

```
npm i qs @xionhub/funnel-core @xionhub/funnel-client @xionhub/funnel-react-router-dom-adapter
```

# Quick Start

## next.js app router
Expand Down Expand Up @@ -251,6 +275,8 @@ Using createStep, you can create, delete, or update the query string for the nex

## Funnel Client

Funnel Client provides utility functions to help manage query string funnels.

### FunnelClient.createStep

```tsx
Expand Down Expand Up @@ -352,6 +378,10 @@ export const NestedFunnel = () => {

[App Router Example](https://github.com/XionWCFM/funnel/tree/main/apps/app-router-example)

[Pages Router Example](https://github.com/XionWCFM/funnel/tree/main/apps/pages-router-example)

[React Router Dom Example](https://github.com/XionWCFM/funnel/tree/main/apps/react-router-example)

# License

Licensed under the MIT license.

0 comments on commit a50e3aa

Please sign in to comment.