diff --git a/README.md b/README.md index eb0db74e..3777679a 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,23 @@ This monorepo contains: - UI Icons React Library - React Component Library +## Branches and releases + +`main` is the development branch. It holds the work for the next release and does **not** correspond to any released version. + +> [!NOTE] +> Before the 11.5 release, `main` reflected the latest release. That is no longer the case. + +To work against a released version, check out the version branch for your Identity Server version: + +```shell +git checkout version/X.Y +``` + +For example, for Identity Server 11.5.x, check out `version/11.5`. + +Version branches keep receiving fixes for their release after it ships, without picking up unreleased development work from `main`. Each release is also tagged as `ui-kit-` (for example `ui-kit-11.5.0`) if you need the exact state that shipped. Releases that have no version branch are available through their tag only. + ## Prerequisites - Node.js (version as specified in the `.nvmrc` file)