Skip to content

Commit 94b863b

Browse files
devondragonclaude
andcommitted
Update README with Spring Boot 4.0 installation and migration guide
- Add Spring Boot 4.0 and 3.5 badges - Add version compatibility table (Spring Boot, Framework, Java, Security) - Add Spring Boot 4.0 installation section with Maven/Gradle examples - Document Spring Boot 4.0 key changes: - Java 21 requirement - Spring Security 7 breaking changes - Jackson 3 updates - Modular test infrastructure package changes - Add required test dependencies for Spring Boot 4.0 - Keep Spring Boot 3.5 section for stable/LTS users - Update Quick Start prerequisites and dependencies 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 8cec5e3 commit 94b863b

1 file changed

Lines changed: 64 additions & 18 deletions

File tree

README.md

Lines changed: 64 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[![Maven Central](https://img.shields.io/maven-central/v/com.digitalsanctuary/ds-spring-user-framework.svg)](https://central.sonatype.com/artifact/com.digitalsanctuary/ds-spring-user-framework)
44
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5-
[![Java Version](https://img.shields.io/badge/Java-17%2B-brightgreen)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
5+
[![Spring Boot 4](https://img.shields.io/badge/Spring%20Boot-4.0-brightgreen)](https://spring.io/projects/spring-boot)
6+
[![Spring Boot 3](https://img.shields.io/badge/Spring%20Boot-3.5-blue)](https://spring.io/projects/spring-boot)
7+
[![Java Version](https://img.shields.io/badge/Java-17%20|%2021-brightgreen)](https://www.oracle.com/java/technologies/downloads/)
68

79
A comprehensive Spring Boot User Management Framework that simplifies the implementation of robust user authentication and management features. Built on top of Spring Security, this library provides ready-to-use solutions for user registration, login, account management, and more.
810

@@ -15,8 +17,8 @@ Check out the [Spring User Framework Demo Application](https://github.com/devond
1517
- [Table of Contents](#table-of-contents)
1618
- [Features](#features)
1719
- [Installation](#installation)
18-
- [Maven](#maven)
19-
- [Gradle](#gradle)
20+
- [Spring Boot 4.0 (Latest)](#spring-boot-40-latest)
21+
- [Spring Boot 3.5 (Stable)](#spring-boot-35-stable)
2022
- [Quick Start](#quick-start)
2123
- [Prerequisites](#prerequisites)
2224
- [Step 1: Add Dependencies](#step-1-add-dependencies)
@@ -90,18 +92,66 @@ Check out the [Spring User Framework Demo Application](https://github.com/devond
9092

9193
## Installation
9294

93-
### Maven
95+
Choose the version that matches your Spring Boot version:
9496

97+
| Spring Boot Version | Framework Version | Java Version | Spring Security |
98+
|---------------------|-------------------|--------------|-----------------|
99+
| 4.0.x | 4.0.x | 21+ | 7.x |
100+
| 3.5.x | 3.5.x | 17+ | 6.x |
101+
102+
### Spring Boot 4.0 (Latest)
103+
104+
Spring Boot 4.0 brings significant changes including Spring Security 7 and requires Java 21.
105+
106+
**Maven:**
95107
```xml
96108
<dependency>
97109
<groupId>com.digitalsanctuary</groupId>
98110
<artifactId>ds-spring-user-framework</artifactId>
99-
<version>3.5.1</version>
111+
<version>4.0.0</version>
100112
</dependency>
101113
```
102114

103-
### Gradle
115+
**Gradle:**
116+
```groovy
117+
implementation 'com.digitalsanctuary:ds-spring-user-framework:4.0.0'
118+
```
119+
120+
#### Spring Boot 4.0 Key Changes
121+
122+
When upgrading to Spring Boot 4.0, be aware of these important changes:
123+
124+
- **Java 21 Required**: Spring Boot 4.0 requires Java 21 or higher
125+
- **Spring Security 7**: Includes breaking changes from Spring Security 6.x
126+
- All URL patterns in security configuration must start with `/`
127+
- Some deprecated APIs have been removed
128+
- **Jackson 3**: JSON processing uses Jackson 3.x with some API changes
129+
- **Modular Test Infrastructure**: Test annotations have moved to new packages:
130+
- `@AutoConfigureMockMvc``org.springframework.boot.webmvc.test.autoconfigure`
131+
- `@DataJpaTest``org.springframework.boot.data.jpa.test.autoconfigure`
132+
- `@WebMvcTest``org.springframework.boot.webmvc.test.autoconfigure`
133+
134+
For testing, you may need these additional dependencies:
135+
```groovy
136+
testImplementation 'org.springframework.boot:spring-boot-data-jpa-test'
137+
testImplementation 'org.springframework.boot:spring-boot-webmvc-test'
138+
testImplementation 'org.springframework.boot:spring-boot-starter-security-test'
139+
```
140+
141+
### Spring Boot 3.5 (Stable)
142+
143+
For projects using Spring Boot 3.5.x with Java 17+:
104144

145+
**Maven:**
146+
```xml
147+
<dependency>
148+
<groupId>com.digitalsanctuary</groupId>
149+
<artifactId>ds-spring-user-framework</artifactId>
150+
<version>3.5.1</version>
151+
</dependency>
152+
```
153+
154+
**Gradle:**
105155
```groovy
106156
implementation 'com.digitalsanctuary:ds-spring-user-framework:3.5.1'
107157
```
@@ -112,27 +162,23 @@ Follow these steps to get up and running with the Spring User Framework in your
112162

113163
### Prerequisites
114164

115-
- Java 17 or higher
116-
- Spring Boot 3.0+
165+
- **For Spring Boot 4.0**: Java 21 or higher
166+
- **For Spring Boot 3.5**: Java 17 or higher
117167
- A database (MariaDB, PostgreSQL, MySQL, H2, etc.)
118168
- SMTP server for email functionality (optional but recommended)
119169

120170
### Step 1: Add Dependencies
121171

122-
1. **Add the main framework dependency**:
172+
1. **Add the main framework dependency** (see [Installation](#installation) for version selection):
123173

124-
Maven:
125-
```xml
126-
<dependency>
127-
<groupId>com.digitalsanctuary</groupId>
128-
<artifactId>ds-spring-user-framework</artifactId>
129-
<version>3.3.0</version>
130-
</dependency>
174+
**Spring Boot 4.0 (Java 21+):**
175+
```groovy
176+
implementation 'com.digitalsanctuary:ds-spring-user-framework:4.0.0'
131177
```
132178

133-
Gradle:
179+
**Spring Boot 3.5 (Java 17+):**
134180
```groovy
135-
implementation 'com.digitalsanctuary:ds-spring-user-framework:3.3.0'
181+
implementation 'com.digitalsanctuary:ds-spring-user-framework:3.5.1'
136182
```
137183

138184
2. **Add required dependencies**:

0 commit comments

Comments
 (0)