Skip to content

Commit 5088ce1

Browse files
committed
minor fixup
1 parent ecee021 commit 5088ce1

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

packages/react-sdk/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ declare module "@bucketco/react-sdk" {
3939

4040
### 2. Add the `BucketProvider` context provider
4141

42-
Add the `BucketProvider` context provider to your application.
43-
This will initialize the Bucket SDK, fetch features and start listening for automated feedback survey events.
42+
Add the `BucketProvider` context provider to your application:
4443

4544
**Example:**
4645

@@ -139,6 +138,8 @@ generates a `check` event.
139138

140139
## `<BucketProvider>` component
141140

141+
The `<BucketProvider>` initializes the Bucket SDK, fetch features and start listening for automated feedback survey events. The component can be configured using a number of props:
142+
142143
- `publishableKey` is used to connect the provider to an _environment_ on Bucket. Find your `publishableKey` under [environment settings](https://app.bucket.co/envs/current/settings/app-environments) in Bucket,
143144
- `company`, `user` and `otherContext` make up the _context_ that is used to determine if a feature is enabled or not. `company` and `user` contexts are automatically transmitted to Bucket servers so the Bucket app can show you which companies have access to which features etc.
144145
> [!Note]

0 commit comments

Comments
 (0)