diff --git a/README.md b/README.md index 55ed977..b2966e1 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![Maven Central status](https://img.shields.io/maven-central/v/org.openfolder/kotlin-asyncapi-parent.svg)](https://search.maven.org/#search%7Cga%7C1%7Corg.openfolder%20kotlin-asyncapi) * [About](#about) +* [Prerequisites](#prerequisites) * [Module Roadmap](#module-roadmap) * [Usage](#usage) * [Kotlin DSL](#kotlin-dsl-usage) @@ -21,6 +22,16 @@ The Kotlin AsyncAPI project aims to provide convenience tools for generating and [Kotlin DSL](https://kotlinlang.org/docs/type-safe-builders.html) for building the specification in a typesafe way. The modules around that core build a framework for documenting asynchronous microservice APIs. +## Prerequisites +The framework generally supports any JVM project. Compatibility has been tested, but is not limited to the following versions: + +| Identifier | Version | +|-----------------|-----------------------------| +| **JRE** | `8`, `11` | +| **Kotlin** | `1.6.21`, `1.7.0`, `1.7.10` | +| **Spring Boot** | `2.6.0`-`2.7.4` | +| **Maven** | `3.8.4`, `3.8.6` | + ## Module Roadmap | Module | Description | State | |-------------------------|--------------------------------------------------------------------------------|--------------------|