Skip to content

Commit 4a0e99f

Browse files
committed
Readme updates.
1 parent b443439 commit 4a0e99f

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

packages/sdk/combined-browser/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# LaunchDarkly JavaScript SDK for Browsers
1+
# LaunchDarkly JavaScript SDK for Browsers with included Observability.
22

3-
[![NPM][browser-sdk-npm-badge]][browser-sdk-npm-link]
4-
[![Actions Status][browser-sdk-ci-badge]][browser-sdk-ci]
5-
[![Documentation][browser-sdk-ghp-badge]][browser-sdk-ghp-link]
6-
[![NPM][browser-sdk-dm-badge]][browser-sdk-npm-link]
7-
[![NPM][browser-sdk-dt-badge]][browser-sdk-npm-link]
3+
[![NPM][combined-browser-sdk-npm-badge]][combined-browser-sdk-npm-link]
4+
[![Actions Status][combined-browser-sdk-ci-badge]][combined-browser-sdk-ci]
5+
[![Documentation][combined-browser-sdk-ghp-badge]][combined-browser-sdk-ghp-link]
6+
[![NPM][combined-browser-sdk-dm-badge]][combined-browser-sdk-npm-link]
7+
[![NPM][combined-browser-sdk-dt-badge]][combined-browser-sdk-npm-link]
88

99
# ⛔️⛔️⛔️⛔️
1010

@@ -18,18 +18,18 @@
1818
1919
```shell
2020
# npm
21-
npm i @launchdarkly/js-client-sdk
21+
npm i @launchdarkly/browser
2222
2323
# yarn
24-
yarn add -D @launchdarkly/js-client-sdk
24+
yarn add -D @launchdarkly/browser
2525
```
2626
-->
2727

2828
## Getting started
2929

3030
Refer to the [SDK documentation](https://docs.launchdarkly.com/sdk/client-side/javascript#getting-started) for instructions on getting started with using the SDK.
3131

32-
Note: _If you are using JavaScript in a non-browser environment, please check our other SDK packages in [js-core](https://github.com/launchdarkly/js-core)_
32+
Note: _If you are using JavaScript in a non-combined-browser environment, please check our other SDK packages in [js-core](https://github.com/launchdarkly/js-core)_
3333
Please note that the JavaScript SDK has two special requirements in terms of your LaunchDarkly environment. First, in terms of the credentials for your environment that appear on your [Account Settings](https://app.launchdarkly.com/settings/projects) dashboard, the JavaScript SDK uses the "Client-side ID"-- not the "SDK key" or the "Mobile key". Second, for any feature flag that you will be using in JavaScript code, you must check the "Make this flag available to client-side SDKs" box on that flag's Settings page.
3434

3535
## Verifying SDK build provenance with the SLSA framework
@@ -51,11 +51,11 @@ LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply
5151
- [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
5252
- [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates
5353

54-
[browser-sdk-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/browser.yml/badge.svg
55-
[browser-sdk-ci]: https://github.com/launchdarkly/js-core/actions/workflows/browser.yml
56-
[browser-sdk-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/js-client-sdk.svg?style=flat-square
57-
[browser-sdk-npm-link]: https://www.npmjs.com/package/@launchdarkly/js-client-sdk
58-
[browser-sdk-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
59-
[browser-sdk-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/browser/docs/
60-
[browser-sdk-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/js-client-sdk.svg?style=flat-square
61-
[browser-sdk-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/js-client-sdk.svg?style=flat-square
54+
[combined-browser-sdk-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/combined-browser.yml/badge.svg
55+
[combined-browser-sdk-ci]: https://github.com/launchdarkly/js-core/actions/workflows/combined-browser.yml
56+
[combined-browser-sdk-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/browser.svg?style=flat-square
57+
[combined-browser-sdk-npm-link]: https://www.npmjs.com/package/@launchdarkly/browser
58+
[combined-browser-sdk-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
59+
[combined-browser-sdk-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/combined-browser/docs/
60+
[combined-browser-sdk-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/browser.svg?style=flat-square
61+
[combined-browser-sdk-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/browser.svg?style=flat-square

0 commit comments

Comments
 (0)