Skip to content

Commit

Permalink
docs: Define prerequisites (#37)
Browse files Browse the repository at this point in the history
docs - Define prerequisites
  • Loading branch information
lorenzsimon authored Sep 25, 2022
1 parent 09e750c commit b692068
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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 |
|-------------------------|--------------------------------------------------------------------------------|--------------------|
Expand Down

0 comments on commit b692068

Please sign in to comment.