Skip to content

Commit d529136

Browse files
Add SemVer description to README (#28)
* Add SemVer description to README * Add SemVer URL to README
1 parent 2d4e0be commit d529136

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ php artisan vendor:publish --provider="WorkOS\Laravel\WorkOSServiceProvider"
3636
The package will need to be configured with your [api key](https://dashboard.workos.com/api-keys) and [project id](https://dashboard.workos.com/sso/configuration).
3737
By default, the package will look for a `WORKOS_API_KEY` and `WORKOS_CLIENT_ID` environment variable.
3838

39+
## SDK Versioning
40+
41+
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.
42+
3943
## More Information
4044

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

0 commit comments

Comments
 (0)