react-shepherd 5.0.2 → 5.0.6

package/README.md

@@ -11,7 +11,7 @@ that can be passed into props for dynamic interactivity.
 Use this simple NPM command or whatever package manager is your favorite.
 
 ```bash
-npm install --save @shepherdpro/react
+npm install --save react-shepherd
 ```
 
 ## Usage
@@ -33,8 +33,8 @@ const tourOptions = {
 };
 
 function Button() {
-  const shepherd = useShepherd(ShepherdTourContext);
-  const tour = shepherd.Tour({
+  const Shepherd = useShepherd();
+  const tour = new Shepherd.Tour({
     ...tourOptions,
     steps: newSteps
   });
@@ -59,7 +59,7 @@ export default function App() {
 
 ## Configuration
 
-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://shepherdjs.dev/docs/Tour.html). You can also pass an API Key to use [Shepherd Pro](https://shepherdpro.com) features for analytics related events tracking.
+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.shepherdpro.com/api/tour/classes/tour/). You can also pass an API Key to use [Shepherd Pro](https://shepherdpro.com) features for analytics related events tracking.
 
 ### apiKey
 
@@ -68,7 +68,7 @@ Used to connect your tours to a Pro instance to get additional user information
 
 ## Steps
 
-The options are the same as Shepherd [options](https://shepherdjs.dev/docs/Step.html).
+The options are the same as Shepherd [options](https://docs.shepherdpro.com/api/step/classes/step/).
 
 ## License
 

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { Context } from 'react';
 import { default as default_2 } from 'shepherd.js';
 import { FC } from 'react';
 import { ReactNode } from 'react';
-import { ShepherdPro } from 'node_modules/shepherd.js/dist/tour';
+import { ShepherdPro } from 'shepherd.js/dist/cjs/tour';
 
 export declare const JourneyMethods: Consumer<ShepherdContextType | undefined>;
 
@@ -16,7 +16,7 @@ export declare const ShepherdJourneyContext: Context<ShepherdContextType | undef
 export declare const ShepherdJourneyProvider: FC<ShepherdProviderProps>;
 
 declare interface ShepherdProviderProps {
-    apiKey: string;
+    apiKey?: string;
     apiPath?: string;
     properties?: Record<string, unknown>;
     children?: ReactNode;