diff --git a/README.adoc b/README.adoc index ab70b99da..3f368f538 100755 --- a/README.adoc +++ b/README.adoc @@ -1,14 +1,14 @@ image:https://ci.spring.io/api/v1/teams/spring-fu/pipelines/spring-fu/badge["Build Status", link="https://ci.spring.io/teams/spring-fu/pipelines/spring-fu"] -Spring Fu is an incubator for https://github.com/spring-projects-experimental/spring-fu/tree/master/jafu[Jafu] (Java DSL) -and https://github.com/spring-projects-experimental/spring-fu/tree/master/kofu[Kofu] (Kotlin DSL) designed to configure +Spring Fu is an incubator for https://github.com/spring-projects-experimental/spring-fu/tree/master/jafu[JaFu] (Java DSL) +and https://github.com/spring-projects-experimental/spring-fu/tree/master/kofu[KoFu] (Kotlin DSL) designed to configure Spring Boot explicitly with code in a declarative way with great discoverability thanks to auto-complete. It provides fast startup (40% faster than regular auto-configuration on a minimal Spring MVC app), low memory consumption and is a good fit with https://www.graalvm.org/docs/reference-manual/native-image/[GraalVM native] thanks to its (almost) reflection-less approach. == Native images -If you are interested in running Spring applications (including Jafu and Kofu ones) as GraalVM native images, +If you are interested in running Spring applications (including JaFu and KoFu ones) as GraalVM native images, see the https://github.com/spring-projects-experimental/spring-graalvm-native[spring-graalvm-native] project and its https://github.com/spring-projects-experimental/spring-graalvm-native/tree/master/spring-graalvm-native-samples/jafu[jafu] and https://github.com/spring-projects-experimental/spring-graalvm-native/tree/master/spring-graalvm-native-samples/jafu-webmvc[jafu-webmvc] samples. == Status diff --git a/build.sh b/build.sh index 93269bbad..f74f6305b 100755 --- a/build.sh +++ b/build.sh @@ -1,5 +1,5 @@ #!/usr/bin/env bash -./gradlew -x javadoc build publishToMavenLocal +./gradlew -x javadoc -x dokka build publishToMavenLocal cd samples ./gradlew build diff --git a/jafu/README.adoc b/jafu/README.adoc index cfcac4ed4..1eb4d14b4 100644 --- a/jafu/README.adoc +++ b/jafu/README.adoc @@ -1,19 +1,19 @@ -:spring-fu-version: 0.3.0.M5 +:spring-fu-version: 0.3.0 :jafu-javadoc-url: http://repo.spring.io/milestone/org/springframework/fu/spring-fu-jafu/{spring-fu-version}/spring-fu-jafu-{spring-fu-version}-javadoc.jar! :framework-javadoc-url: https://docs.spring.io/spring-framework/docs/5.3.x/javadoc-api image:https://img.shields.io/badge/Jafu%20documentation-blue.svg["Jafu documentation", link="{jafu-javadoc-url}/index.html"] -== Jafu DSL for Spring Boot +== JaFu DSL for Spring Boot -Jafu (for **Ja**va and **fu**nctional) is an alternative way of configuring explicitly your Spring Boot application, +JaFu (for **Ja**va and **Fu**nctional) is an alternative way of configuring explicitly your Spring Boot application, different from regular auto-configuration, using a Java DSL. It is based on Spring Boot infrastructure, but https://github.com/spring-projects/spring-fu/tree/master/autoconfigure-adapter[used via functional bean definitions] instead of JavaConfig. === API reference -An overview of Jafu DSL is provided bellow with the related {jafu-javadoc-url}/index.html[API documentation]. +An overview of JaFu DSL is provided bellow with the related {jafu-javadoc-url}/index.html[API documentation]. Be aware that a few static imports will be needed. === Getting started diff --git a/kofu/README.adoc b/kofu/README.adoc index 1bad5ae8e..a2cd6235f 100644 --- a/kofu/README.adoc +++ b/kofu/README.adoc @@ -1,12 +1,12 @@ -:spring-fu-version: 0.3.0.M5 +:spring-fu-version: 0.3.0 :kofu-kdoc-url: http://repo.spring.io/milestone/org/springframework/fu/spring-fu-kofu/{spring-fu-version}/spring-fu-kofu-{spring-fu-version}-javadoc.jar! -:framework-kdoc-url: https://docs.spring.io/spring-framework/docs/5.3.x/kdoc-api +:framework-kdoc-url: https://docs.spring.io/spring-framework/docs/5.2.x/kdoc-api image:https://img.shields.io/badge/Kofu%20documentation-blue.svg["Kofu documentation", link="{kofu-kdoc-url}/kofu/org.springframework.fu.kofu/-application-dsl.html"] -== Kofu DSL for Spring Boot +== KoFu DSL for Spring Boot -Kofu (for **Ko**tlin and **fu**nctional) is an alternative way of configuring explicitly your Spring Boot application, +KoFu (for **Ko**tlin and **Fu**nctional) is an alternative way of configuring explicitly your Spring Boot application, different from regular auto-configuration, using a Kotlin DSL. It is based on Spring Boot infrastructure, but https://github.com/spring-projects/spring-fu/tree/master/autoconfigure-adapter[used via functional bean definitions] instead of JavaConfig. @@ -67,24 +67,6 @@ To use WebFlux.fn instead * Use `spring-boot-starter-webflux` starter instead of `spring-boot-starter-web` * Use `coRouter { }` instead of `router { }` if you want to use Coroutines instead of Reactor API -=== Dependencies - -Kofu is technically just a dependency you add to your Spring Boot project. - -```kotlin -repositories { - mavenCentral() - maven("https://repo.spring.io/milestone") -} - -dependencies { - implementation("org.springframework.fu:spring-fu-kofu:0.3.0.M5") - - implementation("org.springframework.boot:spring-boot-starter-web") - testImplementation("org.springframework.boot:spring-boot-starter-webflux") -} -``` - === Getting started * Go to https://start.spring.io/#!type=gradle-project&language=kotlin[start.spring.io] @@ -114,5 +96,5 @@ fun main() { See also sample projects https://github.com/spring-projects/spring-fu/tree/master/samples[here]. You can now also benefits of -https://docs.spring.io/spring/docs/5.3.x/spring-framework-reference/[Spring Framework reference documentation] +https://docs.spring.io/spring/docs/5.2.x/spring-framework-reference/[Spring Framework reference documentation] which is now available with Kotlin code samples.