Skip to content

docs: align README install versions with the 5.2.0 release #353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devondragon merged 1 commit into from
Aug 12, 2026
Merged

docs: align README install versions with the 5.2.0 release #353

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,10 @@ Choose the version that matches your Spring Boot version:

| Spring Boot Version | Framework Version | Java Version | Spring Security |
| ------------------- | ----------------- | ------------ | --------------- |
| 4.0.x – 4.1.x | 5.1.x | 21+ | 7.x |
| 4.0.x – 4.1.x | 5.2.x | 21+ | 7.x |
| 3.5.x | 3.6.x | 17+ | 6.x |

> **Versioning note:** This library follows Semantic Versioning for its **own** API; its major version is intentionally **not** aligned with Spring Boot's major version. The 5.0.x line is built and verified against **Spring Boot 4.1.0** and also runs on 4.0.x — all Spring Boot starters are `compileOnly`, so your application picks the exact Spring Boot patch version. The `5.0.x` line is a **breaking release** over `4.4.x`; read the **[Migration Guide](MIGRATION.md)** ("Migrating to 5.0.x") before upgrading — note especially the reverse-proxy `user.security.appUrl` requirement.
> **Versioning note:** This library follows Semantic Versioning for its **own** API; its major version is intentionally **not** aligned with Spring Boot's major version. The 5.2.x line is built and verified against **Spring Boot 4.1.0** and also runs on 4.0.x — all Spring Boot starters are `compileOnly`, so your application picks the exact Spring Boot patch version. The `5.0.x` line is a **breaking release** over `4.4.x`; read the **[Migration Guide](MIGRATION.md)** ("Migrating to 5.0.x") before upgrading — note especially the reverse-proxy `user.security.appUrl` requirement.

### Spring Boot 4.x (Latest)

Expand All @@ -135,13 +135,13 @@ Spring Boot 4.x brings significant changes including Spring Security 7 and requi
<dependency>
<groupId>com.digitalsanctuary</groupId>
<artifactId>ds-spring-user-framework</artifactId>
<version>5.1.1</version>
<version>5.2.0</version>
</dependency>
```

**Gradle:**
```groovy
implementation 'com.digitalsanctuary:ds-spring-user-framework:5.1.1'
implementation 'com.digitalsanctuary:ds-spring-user-framework:5.2.0'
```

#### Spring Boot 4.x Key Changes
Expand Down Expand Up @@ -171,7 +171,7 @@ testImplementation 'org.springframework.boot:spring-boot-starter-security-test'

For projects using Spring Boot 3.5.x with Java 17+:

> **Security-maintenance only.** The `3.6.x` line backports security fixes from the 5.0.x line that apply to Spring Boot 3.5; new feature development happens on `5.0.x`. If you are on Java 21 / Spring Boot 4, use `5.0.x`.
> **Security-maintenance only.** The `3.6.x` line backports security fixes from the 5.x line that apply to Spring Boot 3.5; new feature development happens on `5.2.x`. If you are on Java 21 / Spring Boot 4, use `5.2.x`.

**Maven:**
```xml
Expand Down Expand Up @@ -214,7 +214,7 @@ Follow these steps to get up and running with the Spring User Framework in your

**Spring Boot 4.0 / 4.1 (Java 21+):**
```groovy
implementation 'com.digitalsanctuary:ds-spring-user-framework:5.1.1'
implementation 'com.digitalsanctuary:ds-spring-user-framework:5.2.0'
```

**Spring Boot 3.5 (Java 17+):**
Expand Down
Loading