Skip to content

Commit bbd0848

Browse files
Add section about Beta releases in the README.md (#53)
* Add section about Beta releases in the README.md * Improvement to README.md * Update README.md
1 parent a0b9580 commit bbd0848

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,19 @@ By default, the package will look for a `WORKOS_API_KEY` and `WORKOS_CLIENT_ID`
4040

4141
For our SDKs WorkOS follows a Semantic Versioning ([SemVer](https://semver.org/)) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.
4242

43+
## Beta Releases
44+
45+
WorkOS has features in Beta that can be accessed via Beta releases. We would love for you to try these
46+
and share feedback with us before these features reach general availability (GA). To install a Beta version,
47+
please follow the [installation steps](#installation) above using the Beta release version.
48+
49+
> Note: there can be breaking changes between Beta versions. Therefore, we recommend pinning the package version to a
50+
> specific version. This way you can install the same version each time without breaking changes unless you are
51+
> intentionally looking for the latest Beta version.
52+
53+
We highly recommend keeping an eye on when the Beta feature you are interested in goes from Beta to stable so that you
54+
can move to using the stable version.
55+
4356
## More Information
4457

4558
* [Single Sign-On Guide](https://workos.com/docs/sso/guide)

0 commit comments

Comments
 (0)