Skip to content

Commit 3f24ab9

Browse files
committed
fix structure in readme
1 parent 04aa17e commit 3f24ab9

2 files changed

Lines changed: 16 additions & 16 deletions

File tree

packages/browser-sdk/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ type Configuration = {
112112
};
113113
```
114114

115-
### Feature toggles
115+
## Feature toggles
116116

117117
Bucket determines which features are active for a given user/company. The user/company is given in the BucketClient constructor.
118118

@@ -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 (beta)
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,7 +201,7 @@ 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
204+
## Tracking feature usage
205205

206206
The `track` function lets you send events to Bucket to denote feature usage.
207207
By default Bucket expects event names to align with the feature keys, but
@@ -211,7 +211,7 @@ you can customize it as you wish.
211211
bucketClient.track("huddle", { voiceHuddle: true });
212212
```
213213

214-
### Updating user/company/other context
214+
## Updating user/company/other context
215215

216216
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.
217217
They return a promise which resolves once the features have been re-evaluated follow the update of the attributes.
@@ -228,11 +228,11 @@ await bucketClient.updateUser({ voiceHuddleOptIn: (!isEnabled).toString() });
228228

229229
> [!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.
230230
231-
### Qualitative feedback
231+
## Qualitative feedback
232232

233233
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.
234234

235-
#### Automated feedback collection
235+
### Automated feedback collection
236236

237237
The Bucket Browser SDK comes with automated feedback collection mode enabled by default, which lets the Bucket service ask your users for feedback for relevant features just after they've used them.
238238

@@ -244,15 +244,15 @@ It works because the Bucket Browser SDK maintains a live connection to Bucket's
244244

245245
You can find all the options to make changes to the default behavior in the [Bucket feedback documentation](./FEEDBACK.md).
246246

247-
#### Bucket feedback UI
247+
### Bucket feedback UI
248248

249249
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.
250250

251251
![image](https://github.com/bucketco/bucket-javascript-sdk/assets/34348/c387bac1-f2e2-4efd-9dda-5030d76f9532)
252252

253253
[Read the Bucket feedback UI documentation](./FEEDBACK.md)
254254

255-
#### Bucket feedback SDK
255+
### Bucket feedback SDK
256256

257257
Feedback can be submitted to Bucket using the SDK:
258258

@@ -270,7 +270,7 @@ If you are not using the Bucket Browser SDK, you can still submit feedback using
270270

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

273-
### Event listeners
273+
## Event listeners
274274

275275
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:
276276

@@ -297,7 +297,7 @@ const unsub = client.on("enabledCheck", (check: CheckEvent) =>
297297
unsub();
298298
```
299299

300-
### Zero PII
300+
## Zero PII
301301

302302
The Bucket Browser SDK doesn't collect any metadata and HTTP IP addresses are _not_ being stored.
303303

@@ -310,7 +310,7 @@ import { sha256 } from "crypto-hash";
310310
bucket.user(await sha256("john_doe"));
311311
```
312312

313-
### Use of cookies
313+
## Use of cookies
314314

315315
The Bucket Browser SDK uses a couple of cookies to support automated feedback surveys. These cookies are not used for tracking purposes and thus should not need to appear in cookie consent forms.
316316

@@ -319,14 +319,14 @@ The two cookies are:
319319
- `bucket-prompt-${userId}`: store the last automated feedback prompt message ID received to avoid repeating surveys
320320
- `bucket-token-${userId}`: caching a token used to connect to Bucket's live messaging infrastructure that is used to deliver automated feedback surveys in real time.
321321

322-
### Upgrading to 3.0 from 2.x
322+
## Upgrading to 3.0 from 2.x
323323

324324
Breaking changes:
325325

326326
- `client.onFeaturesUpdated()` is now replaced by [event listeners](#event-listeners)
327327
- Arguments to the `BucketClient` constructor which were previously under `featureOptions` are now supplied directly in the root.
328328

329-
### TypeScript
329+
## TypeScript
330330

331331
Types are bundled together with the library and exposed automatically when importing through a package manager.
332332

packages/node-sdk/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ const client = new BucketClient({
226226
});
227227
```
228228

229-
### Remote config (beta)
229+
## Remote config (beta)
230230

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

@@ -696,7 +696,7 @@ client.updateCompany("acme_inc", {
696696
`bindClient()` updates attributes on the Bucket servers but does not automatically
697697
update `Last seen`.
698698
699-
### Zero PII
699+
## Zero PII
700700
701701
The Bucket SDK doesn't collect any metadata and HTTP IP addresses are _not_ being
702702
stored. For tracking individual users, we recommend using something like database
@@ -711,7 +711,7 @@ import { sha256 } from 'crypto-hash';
711711
client.updateUser({ userId: await sha256("john_doe"), ... });
712712
```
713713
714-
### Typescript
714+
## Typescript
715715
716716
Types are bundled together with the library and exposed automatically when importing
717717
through a package manager.

0 commit comments

Comments
 (0)