From 7b7a1f858f6911d9833de4dd22d5d01136414ff9 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Thu, 16 Jan 2025 13:41:06 +0000 Subject: [PATCH] Polish README --- README.md | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index da2a4044..e3dec714 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Spring REST Docs [![Build status][1]][2] [![Revved up by Develocity][24]][25] +# Spring REST Docs [![Build status][1]][2] [![Revved up by Develocity][23]][24] ## Overview @@ -29,23 +29,22 @@ There are several that you can contribute to Spring REST Docs: - Open a [pull request][12]. Please see the [contributor guidelines][13] for details - Ask and answer questions on Stack Overflow using the [`spring-restdocs`][15] tag - - Chat with fellow users [on Gitter][16] ## Third-party extensions | Name | Description | | ---- | ----------- | -| [restdocs-wiremock][17] | Auto-generate WireMock stubs as part of documenting your RESTful API | -| [restdocsext-jersey][18] | Enables Spring REST Docs to be used with [Jersey's test framework][19] | -| [spring-auto-restdocs][20] | Uses introspection and Javadoc to automatically document request and response parameters | -| [restdocs-api-spec][21] | A Spring REST Docs extension that adds API specification support. It currently supports [OpenAPI 2][22] and [OpenAPI 3][23] | +| [restdocs-wiremock][16] | Auto-generate WireMock stubs as part of documenting your RESTful API | +| [restdocsext-jersey][17] | Enables Spring REST Docs to be used with [Jersey's test framework][18] | +| [spring-auto-restdocs][19] | Uses introspection and Javadoc to automatically document request and response parameters | +| [restdocs-api-spec][20] | A Spring REST Docs extension that adds API specification support. It currently supports [OpenAPI 2][21] and [OpenAPI 3][22] | ## Licence Spring REST Docs is open source software released under the [Apache 2.0 license][14]. -[1]: https://ci.spring.io/api/v1/teams/spring-restdocs/pipelines/spring-restdocs-2.0.x/jobs/build/badge (Build status) -[2]: https://ci.spring.io/teams/spring-restdocs/pipelines/spring-restdocs-2.0.x?groups=build +[1]: https://github.com/spring-projects/spring-restdocs/actions/workflows/build-and-deploy-snapshot.yml/badge.svg?branch=main (Build status) +[2]: https://github.com/spring-projects/spring-restdocs/actions/workflows/build-and-deploy-snapshot.yml [3]: https://asciidoctor.org [4]: https://docs.spring.io/spring-framework/docs/4.1.x/spring-framework-reference/htmlsingle/#spring-mvc-test-framework [5]: https://developer.github.com/v3/ @@ -59,13 +58,12 @@ Spring REST Docs is open source software released under the [Apache 2.0 license] [13]: CONTRIBUTING.md [14]: https://www.apache.org/licenses/LICENSE-2.0.html [15]: https://stackoverflow.com/tags/spring-restdocs -[16]: https://gitter.im/spring-projects/spring-restdocs -[17]: https://github.com/ePages-de/restdocs-wiremock -[18]: https://github.com/RESTDocsEXT/restdocsext-jersey -[19]: https://jersey.java.net/documentation/latest/test-framework.html -[20]: https://github.com/ScaCap/spring-auto-restdocs -[21]: https://github.com/ePages-de/restdocs-api-spec -[22]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md -[23]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md -[24]: https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A -[25]: https://ge.spring.io/scans?search.rootProjectNames=spring-restdocs +[16]: https://github.com/ePages-de/restdocs-wiremock +[17]: https://github.com/RESTDocsEXT/restdocsext-jersey +[18]: https://jersey.java.net/documentation/latest/test-framework.html +[19]: https://github.com/ScaCap/spring-auto-restdocs +[20]: https://github.com/ePages-de/restdocs-api-spec +[21]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md +[22]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md +[23]: https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A +[24]: https://ge.spring.io/scans?search.rootProjectNames=spring-restdocs