Skip to content

Commit eedce11

Browse files
authored
Merge pull request #2549 from zinzoddari/fix-readme
Fix README.md
2 parents f87c7b9 + 67c83ae commit eedce11

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
[![Known Vulnerabilities](https://snyk.io/test/github/springdoc/springdoc-openapi.git/badge.svg)](https://snyk.io/test/github/springdoc/springdoc-openapi.git)
55
[![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/springdoc)](https://stackoverflow.com/questions/tagged/springdoc?tab=Votes)
66

7-
IMPORTANT: ``springdoc-openapi v1.7.0 `` is the latest Open Source release supporting Spring Boot 2.x and 1.x.
7+
IMPORTANT: ``springdoc-openapi v1.8.0`` is the latest Open Source release supporting Spring Boot 2.x and 1.x.
88

99
An extended support for [*springdoc-openapi v1*](https://springdoc.org/v1)
1010
project is now available for organizations that need support beyond 2023.
1111

12-
For more details, feel free to reach out: [email protected]
12+
For more details, feel free to reach out: [[email protected]](mailto:[email protected])
1313

14-
If you ❤️ this project consider becoming
14+
``springdoc-openapi`` is on [Open Collective](https://opencollective.com/springdoc). If you ❤️ this project consider becoming
1515
a [sponsor](https://github.com/sponsors/springdoc).
1616

1717
This project is sponsored by
@@ -41,7 +41,6 @@ This project is sponsored by
4141
- [Source Code for Demo Applications.](#source-code-for-demo-applications)
4242
- [Demo Spring Boot 2 Web MVC with OpenAPI 3.](#demo-spring-boot-2-web-mvc-with-openapi-3)
4343
- [Demo Spring Boot 2 WebFlux with OpenAPI 3.](#demo-spring-boot-2-webflux-with-openapi-3)
44-
- [Demo Spring Boot 1 Web MVC with OpenAPI 3.](#demo-spring-boot-1-web-mvc-with-openapi-3)
4544
- [Demo Spring Boot 2 WebFlux with Functional endpoints OpenAPI 3.](#demo-spring-boot-2-webflux-with-functional-endpoints-openapi-3)
4645
- [Demo Spring Boot 2 and Spring Hateoas with OpenAPI 3.](#demo-spring-boot-2-and-spring-hateoas-with-openapi-3)
4746
- [Integration of the library in a Spring Boot 3.x project without the swagger-ui:](#integration-of-the-library-in-a-spring-boot-3x-project-without-the-swagger-ui)
@@ -79,8 +78,7 @@ The following video introduces the Library:
7978

8079
For *spring-boot v3* support, make sure you use [springdoc-openapi v2](https://springdoc.org/)
8180

82-
This is a community-based project, not maintained by the Spring Framework Contributors (
83-
Pivotal)
81+
This is a community-based project, not maintained by the Spring Framework Contributors (Pivotal)
8482

8583
# **Getting Started**
8684

@@ -96,7 +94,7 @@ Pivotal)
9694
* `port`: The server port
9795
* `context-path`: The context path of the application
9896
* Documentation can be available in yaml format as well, on the following path:
99-
/v3/api-docs.yaml
97+
`/v3/api-docs.yaml`
10098
* Add the `springdoc-openapi-ui` library to the list of your project dependencies (No
10199
additional configuration is needed):
102100

@@ -184,15 +182,15 @@ and `@SecurityScheme` annotations within a Spring managed bean.
184182

185183
* Documentation can be available in yaml format as well, on the following path :
186184
/v3/api-docs.yaml
187-
* Add the library to the list of your project dependencies ( No additional configuration
185+
* Add the library to the list of your project dependencies (No additional configuration
188186
is needed)
189187

190188
```xml
191189
<dependency>
192-
<groupId>org.springdoc</groupId>
193-
<artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
194-
<version>last-release-version</version>
195-
</dependency>
190+
<groupId>org.springdoc</groupId>
191+
<artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
192+
<version>last-release-version</version>
193+
</dependency>
196194
```
197195

198196
* This step is optional: For custom path of the swagger documentation in HTML format, add

0 commit comments

Comments
 (0)