Skip to content

Commit

Permalink
updated readme again omg
Browse files Browse the repository at this point in the history
  • Loading branch information
bateman001 committed Dec 11, 2024
1 parent 18ab005 commit d32b616
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# fullstory-react-library
# Fullstory React Library

This is a component library that encourages developers to build with components suped up with Fullstory functionality.

## Installation

Run `npm install @fullstory/fullstory-react-library`
Run `npm install @fullstory/react-library`

## Page Names and Properties

Expand All @@ -17,7 +17,7 @@ The defualt configuration will capture all of the information in the url, meta t
Wrap your Routes with `<FullStoryProvider>` like so

```
import { FullStoryProvider } from "@fullstory/fullstory-react-library";
import { FullStoryProvider } from "@fullstory/react-library";
const App = () => {
return (
Expand All @@ -39,7 +39,7 @@ The url configuration will set page names and properties according to the url. I
Add the capture rule of `url` to your `FullStoryProvider`.

```
import { FullStoryProvider } from "@fullstory/fullstory-react-library";
import { FullStoryProvider } from "@fullstory/react-library";
const App = () => {
return (
Expand All @@ -61,7 +61,7 @@ The meta configuration will capture all of the information in the meta tags. It
Add the capture rule of `meta` to your `FullStoryProvider`.

```
import { FullStoryProvider } from "@fullstory/fullstory-react-library";
import { FullStoryProvider } from "@fullstory/react-library";
const App = () => {
return (
Expand All @@ -84,7 +84,7 @@ The schema configuration will capture all of the information in the schemas on t
Add the capture rule of `schema` to your `FullStoryProvider`.

```
import { FullStoryProvider } from "@fullstory/fullstory-react-library";
import { FullStoryProvider } from "@fullstory/react-library";
const App = () => {
return (
Expand Down Expand Up @@ -130,7 +130,7 @@ Additionally we can overried the default capture rules by add capture rules to c
Add the capture rules by defining the page and the rule you expect to `FullStoryProvider`.

```
import { FullStoryProvider } from "@fullstory/fullstory-react-library";
import { FullStoryProvider } from "@fullstory/react-library";
const App = () => {
return (
Expand All @@ -152,7 +152,7 @@ If you would like FullStory to capture custom pagenames and properties we can us
**Implementation:**

```
import { FullStoryProvider } from "@fullstory/fullstory-react-library";
import { FullStoryProvider } from "@fullstory/react-library";
const App = () => {
return (
Expand All @@ -168,7 +168,7 @@ const App = () => {
Then we can use the hook anywhere within the provider like this:

```
import { useFSNavigate } from "@fullstory/fullstory-react-library";
import { useFSNavigate } from "@fullstory/react-library";
const Button = (props) => {
const { property } = props
Expand Down

0 comments on commit d32b616

Please sign in to comment.