This is an automated email from the ASF dual-hosted git repository.
tandraschko pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/openwebbeans.git
The following commit(s) were added to refs/heads/main by this push:
new cdd9785ee Update README.asciidoc
cdd9785ee is described below
commit cdd9785ee7d31e4c23486b34a1faebc9e45a4cdf
Author: Thomas Andraschko <[email protected]>
AuthorDate: Tue Apr 14 10:22:27 2026 +0200
Update README.asciidoc
---
README.asciidoc | 148 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 143 insertions(+), 5 deletions(-)
diff --git a/README.asciidoc b/README.asciidoc
index d449f4566..eca4c30f1 100644
--- a/README.asciidoc
+++ b/README.asciidoc
@@ -1,9 +1,147 @@
-= Apache OpenWebBeans README
+<div align="center">
+<img src="https://openwebbeans.apache.org/images/owb_logo.png" width="300" />
+</div>
+<br>
-=== What is Apache OpenWebBeans?
+
+[](https://github.com/apache/openwebbeans/actions)
+[](https://opensource.org/licenses/Apache-2.0)
-Apache OpenWebBeans (OWB) is an implementation of the Contexts and Dependency
Injection 2.0 specification (CDI-2.0).
+Apache's implementation of the Contexts and Dependency Injection (CDI) /
Jakarta CDI specification
-OWB is modularly built and a full CDI container in under 1 MB total.
+## Branches
-Please visit https://openwebbeans.apache.org for more documentation
\ No newline at end of file
+### main
+Jakarta CDI 4.1 implementation (Jakarta EE 11)
+Requires Java 17+
+
+### owb_4.0.x
+
+Jakarta CDI 4.0 implementation
+Requires Java 11+
+
+### owb_2.0.x
+
+CDI 2.0 (JSR-365) implementation
+Requires Java 8+. Uses a shaded version of ASM-8 (Java 11 support) for proxy
generation.
+
+### owb_1.7.x
+
+CDI 1.2 (JSR-346) implementation
+Requires Java 7+.
+
+### owb_1.2.x
+
+CDI 1.0 (JSR-299) implementation
+Requires Java 5+.
+
+## Minimum Requirements (main)
+
+- Java 17+
+- CDI 4.1 (Jakarta CDI / Jakarta EE 11)
+- TCK compliant
+
+## Installation
+
+```
+mvn clean install
+```
+
+## Usage
+
+### Core Dependency
+
+```xml
+<dependency>
+ <groupId>org.apache.openwebbeans</groupId>
+ <artifactId>openwebbeans-impl</artifactId>
+ <version>${owb.version}</version>
+</dependency>
+<dependency>
+ <groupId>org.apache.openwebbeans</groupId>
+ <artifactId>openwebbeans-spi</artifactId>
+ <version>${owb.version}</version>
+</dependency>
+```
+
+### Web / Servlet Integration
+
+```xml
+<dependency>
+ <groupId>org.apache.openwebbeans</groupId>
+ <artifactId>openwebbeans-web</artifactId>
+ <version>${owb.version}</version>
+</dependency>
+```
+
+### JSF Integration
+
+```xml
+<dependency>
+ <groupId>org.apache.openwebbeans</groupId>
+ <artifactId>openwebbeans-jsf</artifactId>
+ <version>${owb.version}</version>
+</dependency>
+```
+
+### Tomcat Integration
+
+```xml
+<dependency>
+ <groupId>org.apache.openwebbeans</groupId>
+ <artifactId>openwebbeans-tomcat</artifactId>
+ <version>${owb.version}</version>
+</dependency>
+```
+
+### Arquillian Integration (Testing)
+
+```xml
+<dependency>
+ <groupId>org.apache.openwebbeans</groupId>
+ <artifactId>openwebbeans-arquillian</artifactId>
+ <version>${owb.version}</version>
+ <scope>test</scope>
+</dependency>
+```
+
+### JUnit 5 Integration (Testing)
+
+```xml
+<dependency>
+ <groupId>org.apache.openwebbeans</groupId>
+ <artifactId>openwebbeans-junit5</artifactId>
+ <version>${owb.version}</version>
+ <scope>test</scope>
+</dependency>
+```
+
+## Modules
+
+OWB is modularly built — a full CDI container in under 1 MB total. Available
modules include:
+
+- `openwebbeans-impl` — core CDI container implementation
+- `openwebbeans-spi` — SPI interfaces
+- `openwebbeans-web` — Servlet / web container integration
+- `openwebbeans-jsf` — Jakarta Faces integration
+- `openwebbeans-tomcat` — Apache Tomcat integration
+- `openwebbeans-jetty9` — Jetty 9 integration
+- `openwebbeans-ejb` — EJB integration
+- `openwebbeans-jms` — JMS integration
+- `openwebbeans-el22` — EL 2.2+ integration
+- `openwebbeans-osgi` — OSGi environment support
+- `openwebbeans-se` — Java SE standalone support
+- `openwebbeans-slf4j` — SLF4J logging bridge
+- `openwebbeans-junit5` — JUnit 5 test support
+- `openwebbeans-arquillian` — Arquillian test support
+- `openwebbeans-gradle` — Gradle build support
+
+## Java SE Usage
+
+OWB can run as a standalone CDI container in plain Java SE applications
(Swing, JavaFX, Eclipse RCP, etc.) without any application server or servlet
container.
+
+## More Information
+
+Please visit https://openwebbeans.apache.org for full documentation, examples,
and release notes.
+
+Issue tracker: https://issues.apache.org/jira/browse/OWB