From 25a491e6455906194544a0b3b5c8d62a2f07c0be Mon Sep 17 00:00:00 2001 From: Joe Di Pol Date: Mon, 16 Oct 2023 10:39:48 -0700 Subject: [PATCH] Update README.md for Helidon 4 --- README.md | 44 +++++++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index aa421500a1f..472885a164a 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@

- - latest version + + latest version - - latest version + + latest version follow on Twitter @@ -18,14 +18,17 @@ Project Helidon is a set of Java Libraries for writing microservices. Helidon supports two programming models: -* Helidon MP: [MicroProfile](https://microprofile.io/) 3.3 +* Helidon MP: [MicroProfile 6.0](https://microprofile.io/compatible/6-0/) * Helidon SE: a small, functional style API -In either case your application is just a Java SE program. +In either case your application is a Java SE program running on the +new Helidon NĂ­ma WebServer that has been written from the ground up to +use Java 21 Virtual Threads. -## Early access branch -This branch requires Java 21 early access release. -Kindly use latest official release to work with Java 17, unless you are interested in the newest and greatest! +In Helidon 4 each request is processed by a dedicated virtual thread so +your code is free to perform blocking operations without impacting your servers +ability to handle other requests. You get all the throughput of a reactive +server with none of the complexity. ## License @@ -48,7 +51,7 @@ See Getting Started at . ## Helidon CLI -MacOS: +macOS: ```bash curl -O https://helidon.io/cli/latest/darwin/helidon chmod +x ./helidon @@ -71,13 +74,9 @@ See this [document](HELIDON-CLI.md) for more info. ## Build -You need JDK 17+ to build Helidon. +You need JDK 21 to build Helidon 4. -You also need Maven. We recommend 3.6.1 or newer. - -Building the documentation requires the `dot` utility from Graphviz. -This is included in many Linux distributions. For other platforms -see . +You also need Maven. We recommend 3.8.0 or newer. **Full build** ```bash @@ -86,24 +85,31 @@ $ mvn install **Checkstyle** ```bash -# Cd to the component you want to check +# cd to the component you want to check $ mvn validate -Pcheckstyle ``` **Copyright** ```bash -# Cd to the component you want to check +# cd to the component you want to check $ mvn validate -Pcopyright ``` **Spotbugs** ```bash -# Cd to the component you want to check +# cd to the component you want to check $ mvn verify -Pspotbugs ``` +**Documentatonn** + +```bash +# At the root of the project +$ mvn site +``` + **Build Scripts** Build scripts are located in `etc/scripts`. These are primarily used by our pipeline,