From c5ffa293acde1b3da1bf363aa56e1740dbbd9549 Mon Sep 17 00:00:00 2001 From: Norman Maurer Date: Sun, 27 Dec 2020 10:14:08 +0100 Subject: [PATCH] Update README Motivation: We can add some status badge and also should clarify requirements. Modifictations: - Add status badge - Clarify requirements Result: Cleanup docs --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c85a0c3dd1..50f432250b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +![Build project](https://github.com/netty/netty/workflows/Build%20project/badge.svg) + # Netty Project Netty is an asynchronous event-driven network application framework for rapid development of maintainable high performance protocol servers & clients. @@ -15,19 +17,19 @@ For the detailed information about building and developing Netty, please visit [ You require the following to build Netty: -* Latest stable [Oracle JDK 7](https://www.oracle.com/technetwork/java/) +* Latest stable [OpenJDK 8]https://adoptopenjdk.net) * Latest stable [Apache Maven](https://maven.apache.org/) * If you are on Linux, you need [additional development packages](https://netty.io/wiki/native-transports.html) installed on your system, because you'll build the native transport. -Note that this is build-time requirement. JDK 5 (for 3.x) or 6 (for 4.0+) is enough to run your Netty-based application. +Note that this is build-time requirement. JDK 5 (for 3.x) or 6 (for 4.0+ / 4.1+) is enough to run your Netty-based application. ## Branches to look -Development of all versions takes place in each branch whose name is identical to `.`. For example, the development of 3.9 and 4.0 resides in [the branch '3.9'](https://github.com/netty/netty/tree/3.9) and [the branch '4.0'](https://github.com/netty/netty/tree/4.0) respectively. +Development of all versions takes place in each branch whose name is identical to `.`. For example, the development of 3.9 and 4.1 resides in [the branch '3.9'](https://github.com/netty/netty/tree/3.9) and [the branch '4.1'](https://github.com/netty/netty/tree/4.1) respectively. -## Usage with JDK 9 +## Usage with JDK 9+ -Netty can be used in modular JDK9 applications as a collection of automatic modules. The module names follow the +Netty can be used in modular JDK9+ applications as a collection of automatic modules. The module names follow the reverse-DNS style, and are derived from subproject names rather than root packages due to historical reasons. They are listed below: