|
1 | 1 | # react |
2 | 2 |
|
3 | | -[](https://www.npmjs.com/package/@shepherdpro/react) |
| 3 | +[](https://www.npmjs.com/package/react-shepherd) |
4 | 4 |
|
5 | | -This is a React wrapper for the [Shepherd](https://github.com/@shepherdpro/react) tour library. |
6 | | -It's mainly a wrapper around the Shepherd library that exposes the tour object and methods to the context object |
7 | | -that can be passed into props for dynamic interactivity. |
| 5 | +This is a React wrapper for the |
| 6 | +[Shepherd](https://github.com/shipshapecode/shepherd) tour library. It's mainly |
| 7 | +a wrapper around the Shepherd library that exposes the tour object and methods |
| 8 | +to the context object that can be passed into props for dynamic interactivity. |
8 | 9 |
|
9 | 10 | ## Install |
10 | 11 |
|
@@ -59,14 +60,19 @@ export default function App() { |
59 | 60 |
|
60 | 61 | ## Configuration |
61 | 62 |
|
62 | | -The following configuration options for a tour can be set on the `useShepherd` hook to control the way that Shepherd is used. This is simply a POJO passed to Shepherd to use the options noted in the Shepherd Tour [options](https://docs.shepherdjs.dev/api/tour/classes/tour/). |
| 63 | +The following configuration options for a tour can be set on the `useShepherd` |
| 64 | +hook to control the way that Shepherd is used. This is simply a POJO passed to |
| 65 | +Shepherd to use the options noted in the Shepherd Tour |
| 66 | +[options](https://docs.shepherdjs.dev/api/tour/classes/tour/). |
63 | 67 |
|
64 | 68 | ## License |
65 | 69 |
|
66 | | -`react-shepherd` is licensed under **AGPL-3.0** (for open source and non-commercial use) with a **Commercial License** available for commercial use. |
| 70 | +`react-shepherd` is licensed under **AGPL-3.0** (for open source and |
| 71 | +non-commercial use) with a **Commercial License** available for commercial use. |
67 | 72 |
|
68 | 73 | - **Free** for open source and non-commercial projects under AGPL-3.0 |
69 | | -- **Commercial license required** for commercial products and revenue-generating companies |
| 74 | +- **Commercial license required** for commercial products and revenue-generating |
| 75 | + companies |
70 | 76 |
|
71 | 77 | 📄 [Read License Details](../../LICENSE.md) |
72 | 78 | 💳 [Purchase Commercial License](https://shepherdjs.dev/pricing) |
0 commit comments