Skip to content

Commit 41d9a7c

Browse files
authored
Update README.md
1 parent 5121a1e commit 41d9a7c

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,48 +4,50 @@
44

55
## What is this?
66

7-
This is a sample project demos how to use JWT token based authentication to protect the RESTful APIs in a Spring WebMVC application.
7+
This is a sample project that demonstrates how to use JWT token-based authentication to protect RESTful APIs in a Spring Web MVC application.
88

9-
> If you are interested in the new variant built with the Spring WebFlux stack, check [spring-reactive-jwt-sample](https://github.com/hantsy/spring-reactive-jwt-sample/) for more details.
9+
>
10+
> [!note]
11+
>If you are interested in the new variant built with the Spring WebFlux stack, check [spring-reactive-jwt-sample](https://github.com/hantsy/spring-reactive-jwt-sample/) for more details.
1012
1113
## Guide
1214

13-
Check the [step-by-step GUIDE](./GUIDE.md) to get the detailed explanation of the example codes.
15+
Please refer to the [step-by-step guide](./GUIDE.md) for a detailed explanation of the example codes.
1416

15-
> The original codes were written in Spring Boot 2.0, there are some slightly difference in the main/master branch due to the changes brought in the latest Spring Boot 3.0.
17+
> The original code was written in Spring Boot 2.0. There are some slight differences in the main/master branch due to the changes introduced in the latest Spring Boot 3.x.
1618
1719
## Prerequisites
1820

19-
Make sure you have installed the following software.
21+
Please ensure that you have installed the following software.
2022

21-
* Java 17
22-
* Apache Maven 3.6.x
23+
* Java 21
24+
* Apache Maven 3.9.x/4.0.0+
2325
* Docker
2426

25-
## Build
27+
## Build
2628

27-
Clone the source codes from Github.
29+
Clone the source code from GitHub.
2830

2931
```bash
3032
git clone https://github.com/hantsy/spring-webmvc-jwt-sample
3133
```
3234

33-
Open a terminal, and switch to the root folder of the project, and run the following command to build the whole project.
35+
Open a terminal, switch to the project's root folder, and run the following command to build the entire project.
3436

3537
```bash
36-
docker-compose up postgres // start up a postgres
38+
docker compose up postgres // start up a postgres
3739
mvn clean install // build the project
3840
```
3941

40-
Run the application.
42+
Please proceed with executing the following command to run the application.
4143

4244
```bash
43-
mvn spring-boot:run
44-
// or from command line after building
45+
mvn spring-boot: run
46+
// or from the command line after building
4547
java -jar target/xxx.jar
4648
```
4749

48-
4950
## Contribution
5051

51-
Any suggestions are welcome, filing an issue or submitting a PR is also highly recommended.
52+
Any suggestions are welcome, filing an issue or submitting a PR is also highly recommended.
53+

0 commit comments

Comments
 (0)