Skip to content

Commit 76901b7

Browse files
authored
Remove Beta and reordering (#423)
- Removed outdated Beta label - Moved Toolbar up - Removed Feedback image (as it's on the subpage)
1 parent 1286e4f commit 76901b7

1 file changed

Lines changed: 44 additions & 46 deletions

File tree

packages/browser-sdk/README.md

Lines changed: 44 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ by down-stream clients, like the React SDK.
174174
Note that accessing `isEnabled` on the object returned by `getFeatures` does not automatically
175175
generate a `check` event, contrary to the `isEnabled` property on the object returned by `getFeature`.
176176

177-
## Remote config (beta)
177+
## Remote config
178178

179179
Remote config is a dynamic and flexible approach to configuring feature behavior outside of your app – without needing to re-deploy it.
180180

@@ -201,16 +201,6 @@ const features = bucketClient.getFeatures();
201201
Just as `isEnabled`, accessing `config` on the object returned by `getFeatures` does not automatically
202202
generate a `check` event, contrary to the `config` property on the object returned by `getFeature`.
203203

204-
## Tracking feature usage
205-
206-
The `track` function lets you send events to Bucket to denote feature usage.
207-
By default Bucket expects event names to align with the feature keys, but
208-
you can customize it as you wish.
209-
210-
```ts
211-
bucketClient.track("huddle", { voiceHuddle: true });
212-
```
213-
214204
## Updating user/company/other context
215205

216206
Attributes given for the user/company/other context in the BucketClient constructor can be updated for use in feature targeting evaluation with the `updateUser()`, `updateCompany()` and `updateOtherContext()` methods.
@@ -228,7 +218,43 @@ await bucketClient.updateUser({ voiceHuddleOptIn: (!isEnabled).toString() });
228218

229219
> [!NOTE] > `user`/`company` attributes are also stored remotely on the Bucket servers and will automatically be used to evaluate feature targeting if the page is refreshed.
230220
231-
## Qualitative feedback
221+
## Toolbar
222+
223+
The Bucket Toolbar is great for toggling features on/off for yourself to ensure that everything works both when a feature is on and when it's off.
224+
225+
<img width="352" alt="Toolbar screenshot" src="https://github.com/user-attachments/assets/c223df5a-4bd8-49a1-8b4a-ad7001357693" />
226+
227+
The toolbar will automatically appear on `localhost`. However, it can also be incredibly useful in production.
228+
You have full control over when it appears through the `toolbar` configuration option passed to the `BucketClient`.
229+
230+
You can pass a simple boolean to force the toolbar to appear/disappear:
231+
232+
```typescript
233+
const client = new BucketClient({
234+
// show the toolbar even in production if the user is an internal/admin user
235+
toolbar: user?.isInternal,
236+
...
237+
});
238+
```
239+
240+
You can also configure the position of the toolbar on the screen:
241+
242+
```typescript
243+
const client = new BucketClient({
244+
toolbar: {
245+
show: true;
246+
position: {
247+
placement: "bottom-left",
248+
offset: {x: "1rem", y: "1rem"}
249+
}
250+
}
251+
...
252+
})
253+
```
254+
255+
See [the reference](https://docs.bucket.co/supported-languages/browser-sdk/globals#toolbaroptions) for details.
256+
257+
## Qualitative feedback on beta features
232258

233259
Bucket can collect qualitative feedback from your users in the form of a [Customer Satisfaction Score](https://en.wikipedia.org/wiki/Customer_satisfaction) and a comment.
234260

@@ -248,8 +274,6 @@ You can find all the options to make changes to the default behavior in the [Buc
248274

249275
Bucket can assist you with collecting your user's feedback by offering a pre-built UI, allowing you to get started with minimal code and effort.
250276

251-
![image](https://github.com/bucketco/bucket-javascript-sdk/assets/34348/c387bac1-f2e2-4efd-9dda-5030d76f9532)
252-
253277
[Read the Bucket feedback UI documentation](./FEEDBACK.md)
254278

255279
### Bucket feedback SDK
@@ -270,42 +294,16 @@ If you are not using the Bucket Browser SDK, you can still submit feedback using
270294

271295
See details in [Feedback HTTP API](https://docs.bucket.co/reference/http-tracking-api#feedback)
272296

273-
## Toolbar
274-
275-
The Bucket Toolbar is great for toggling features on/off for yourself to ensure that everything works both when a feature is on and when it's off.
276-
277-
<img width="352" alt="Toolbar screenshot" src="https://github.com/user-attachments/assets/c223df5a-4bd8-49a1-8b4a-ad7001357693" />
278-
279-
The toolbar will automatically appear on `localhost`. However, it can also be incredibly useful in production.
280-
You have full control over when it appears through the `toolbar` configuration option passed to the `BucketClient`.
281-
282-
You can pass a simple boolean to force the toolbar to appear/disappear:
283-
284-
```typescript
285-
const client = new BucketClient({
286-
// show the toolbar even in production if the user is an internal/admin user
287-
toolbar: user?.isInternal,
288-
...
289-
});
290-
```
297+
## Tracking feature usage
291298

292-
You can also configure the position of the toolbar on the screen:
299+
The `track` function lets you send events to Bucket to denote feature usage.
300+
By default Bucket expects event names to align with the feature keys, but
301+
you can customize it as you wish.
293302

294-
```typescript
295-
const client = new BucketClient({
296-
toolbar: {
297-
show: true;
298-
position: {
299-
placement: "bottom-left",
300-
offset: {x: "1rem", y: "1rem"}
301-
}
302-
}
303-
...
304-
})
303+
```ts
304+
bucketClient.track("huddle", { voiceHuddle: true });
305305
```
306306

307-
See [the reference](https://docs.bucket.co/supported-languages/browser-sdk/globals#toolbaroptions) for details.
308-
309307
## Event listeners
310308

311309
Event listeners allow for capturing various events occurring in the `BucketClient`. This is useful to build integrations with other system or for various debugging purposes. There are 5 kinds of events:

0 commit comments

Comments
 (0)