Skip to content

Commit

Permalink
Add section about Beta releases in the README.md (#53)
Browse files Browse the repository at this point in the history
* Add section about Beta releases in the README.md

* Improvement to README.md

* Update README.md
  • Loading branch information
amadeo-workos authored Apr 25, 2024
1 parent a0b9580 commit bbd0848
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,19 @@ By default, the package will look for a `WORKOS_API_KEY` and `WORKOS_CLIENT_ID`

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.

## Beta Releases

WorkOS has features in Beta that can be accessed via Beta releases. We would love for you to try these
and share feedback with us before these features reach general availability (GA). To install a Beta version,
please follow the [installation steps](#installation) above using the Beta release version.

> Note: 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.
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 to using the stable version.

## More Information

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

0 comments on commit bbd0848

Please sign in to comment.