Skip to content

Commit 9cc783b

Browse files
authored
Rename beta SDKs to public preview SDKs in readme (#1998)
* Rename beta SDKs to public preview SDKs in readme * More details in installation steps * Update README.md
1 parent e56d6d3 commit 9cc783b

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -255,18 +255,17 @@ You can disable this behavior if you prefer:
255255
Stripe.enableTelemetry = false;
256256
```
257257

258-
### Beta SDKs
258+
### Public Preview SDKs
259259

260-
Stripe has features in the beta phase that can be accessed via the beta version of this package.
261-
We would love for you to try these and share feedback with us before these features reach the stable phase.
262-
To install a beta version of stripe-java follow steps [installation steps above](#installation) using the beta library version.
260+
Stripe has features in the [public preview phase](https://docs.stripe.com/release-phases) that can be accessed via the beta version of this package.
261+
We would love for you to try these as we incrementally release new features and improve them based on your feedback.
263262

264-
> **Note**
265-
> There can be breaking changes between beta versions. Therefore we recommend pinning the package version to a specific version. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest beta version.
263+
The public preview SDKs are different versions of the same package as the stable SDKs. These versions are appended with `-beta.X` such as `25.1.0-beta.1`. To install, choose the version that includes support for the preview feature you are interested in by reviewing the [releases page](https://github.com/stripe/stripe-java/releases/) and then use it [installation steps above](#installation).
266264

267-
We highly recommend keeping an eye on when the beta feature you are interested in goes from beta to stable so that you can move from using a beta version of the SDK to the stable version.
265+
> **Note**
266+
> There can be breaking changes between two versions of the public preview SDKs without a bump in the major version. Therefore we recommend pinning the package version to a specific version. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest public preview SDK.
268267
269-
If your beta feature requires a `Stripe-Version` header to be sent, set the `Stripe.stripeVersion` field by calling `Stripe.addBetaVersion`:
268+
If your beta feature requires a `Stripe-Version` header to be sent, set the `Stripe.stripeVersion` field by calling `Stripe.addBetaVersion` (available only in the public preview SDKs):
270269

271270
> **Note**
272271
> Beta version headers can only be set in beta versions of the library.

0 commit comments

Comments
 (0)