Skip to content

Commit 2532379

Browse files
authored
chore: remove pre-release, update readme (#908)
- prompts a release of a non-experimental react-sdk - updates README to point to React and NestJS SDKs - removes version of peer deps from README (too brittle, point users to `package.json`) - adds an FAQ question --------- Signed-off-by: Todd Baert <[email protected]>
1 parent ba1be5c commit 2532379

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ This repository contains both the server-side JS and web-browser SDKs.
2929
For details, including API documentation, see the respective README files.
3030

3131
- [Server SDK](./packages/server/README.md), for use in Node.js and similar runtimes.
32+
- [NestJS SDK](./packages/nest/README.md), a distribution of the Server SDK with built-in NestJS-specific features.
3233
- [Client SDK](./packages/client/README.md), for use in the web browser.
34+
- [React SDK](./packages/react//README.md), a distribution of the Client SDK with built-in React-specific features.
3335

3436
Each have slightly different APIs, but share many underlying types and components.
3537

packages/react/README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
<!-- x-hide-in-docs-end -->
1313
<!-- The 'github-badges' class is used in the docs -->
1414
<p align="center" class="github-badges">
15-
<a href="https://github.com/open-feature/spec/releases/tag/v0.7.0">
16-
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.7.0&color=yellow&style=for-the-badge" />
15+
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
16+
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
1717
</a>
1818
<!-- x-release-please-start-version -->
1919
<a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.3.2-experimental">
@@ -34,8 +34,6 @@
3434

3535
<!-- x-hide-in-docs-end -->
3636

37-
🧪 This SDK is experimental.
38-
3937
## Overview
4038

4139
The OpenFeature React SDK adds React-specific functionality to the [OpenFeature Web SDK](https://openfeature.dev/docs/reference/technologies/client/web).
@@ -83,10 +81,11 @@ yarn add @openfeature/react-sdk @openfeature/web-sdk @openfeature/core
8381

8482
#### Required peer dependencies
8583

86-
The following list contains the peer dependencies of `@openfeature/react-sdk` with its expected and compatible versions:
84+
The following list contains the peer dependencies of `@openfeature/react-sdk`.
85+
See the [package.json](./package.json) for the required versions.
8786

88-
* `@openfeature/web-sdk`: >=1.0.0
89-
* `react`: >=16.8.0
87+
* `@openfeature/web-sdk`
88+
* `react`
9089

9190
### Usage
9291

@@ -294,6 +293,12 @@ To scope an OpenFeatureProvider to a particular provider/context set the `domain
294293
</OpenFeatureProvider>
295294
```
296295

296+
> I can import things form the `@openfeature/react-sdk`, `@openfeature/web-sdk`, and `@openfeature/core`; which should I use?
297+
298+
The `@openfeature/react-sdk` re-exports everything from its peers (`@openfeature/web-sdk` and `@openfeature/core`), and adds the React-specific features.
299+
You can import everything from the `@openfeature/react-sdk` directly.
300+
Avoid importing anything from `@openfeature/web-sdk` or `@openfeature/core`.
301+
297302
## Resources
298303

299304
- [Example repo](https://github.com/open-feature/react-test-app)

release-please-config.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@
2020
"versioning": "default"
2121
},
2222
"packages/react": {
23+
"release-as": "0.3.2",
2324
"release-type": "node",
24-
"prerelease": true,
25+
"prerelease": false,
2526
"bump-minor-pre-major": true,
2627
"bump-patch-for-minor-pre-major": true,
2728
"extra-files": ["README.md"],

0 commit comments

Comments
 (0)