From 0e2cb2573f6ec939c91daeb24efb0302e0364dfb Mon Sep 17 00:00:00 2001 From: Florian Benz Date: Fri, 15 Sep 2023 09:08:56 +0200 Subject: [PATCH] Add end-of-life notice to the README (#474) * Add end-of-life notice to the README * Add header for end of life notice --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index ce16be40..16ba0d7a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ +# End-of-life Notice + +This project is officially end-of-life. Users are welcome to maintain it in a +fork, but there will be no more Scalable-authored changes published. While Spring +Auto REST Docs helped us over the years to maintain our API documentation, +we decided to move to [OpenAPI] and phased out the usage internally. At Scalable, +[springdoc-openapi] helps us now to automate the generation of API documentation. + +[OpenAPI]: https://www.openapis.org/ +[springdoc-openapi]: https://springdoc.org/ + +--- + # Spring Auto REST Docs [![Apache License 2](https://img.shields.io/badge/license-ASF2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.txt) [![Build status](https://github.com/ScaCap/spring-auto-restdocs/actions/workflows/build.yaml/badge.svg)](https://github.com/ScaCap/spring-auto-restdocs/actions/workflows/build.yaml)