[myfaces-tobago] branch main updated: TOBAGO-2164

[hn...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hnoeth pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/myfaces-tobago.git


The following commit(s) were added to refs/heads/main by this push:
     new badfcbe102 TOBAGO-2164
badfcbe102 is described below

commit badfcbe102ee79594e375d0dacb876cf95531809
Author: Carsten Dimmek <ca...@gmail.com>
AuthorDate: Fri Oct 28 11:23:37 2022 +0200

    TOBAGO-2164
---
 README.md | 96 ++++++++++++++++++++++++++++++++++++++++++---------------------
 1 file changed, 64 insertions(+), 32 deletions(-)

diff --git a/README.md b/README.md
index b3db527042..707f62c74f 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,39 @@
-# Apache Tobago
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 ![Tobago CI](https://github.com/apache/myfaces-tobago/workflows/Tobago%20CI/badge.svg)
 ![CodeQL](https://github.com/apache/myfaces-tobago/workflows/CodeQL/badge.svg)
 [![Build Status ASF](https://ci-builds.apache.org/buildStatus/icon?subject=ASF-Build&job=MyFaces%2FTobago+pipeline%2Fmaster)](https://ci-builds.apache.org/job/MyFaces/job/Tobago%20pipeline/job/master/)
 
+# Apache Tobago
+
+
+Apache MyFaces Tobago is a JSF component framework that pays special attention to security and is optimized for business applications.
+
+Tobago supports custom themes based on the popular Bootstrap framework and frees the user from having to develop complex CSS and Javascript components.
+
+Compared to many other JSF frameworks, Tobago is still being actively developed and is used in many projects.
+
+# Table of Contents
+
+- [Getting Started](#getting-started)
+  * [Prerequisites](#prerequisites)
+  * [Building](#building)
+- [Live Demo](#live-demo)
+- [Examples](#examples)
+- [Issue Tracking](#issue-tracking)
+- [Contributing](#contributing)
+- [Licensing](#licensing)
+
+
+# Getting Started
+
+## Prerequisites
+
+[Git](https://help.github.com/set-up-git-redirect), [Maven 3](https://maven.apache.org/download.cgi) and at least [JDK8]( https://www.oracle.com/technetwork/java/javase/downloads).
+
+
 ## Building
 
-You need Maven 3 and Java 8 or later to build Tobago.
 
 In the project directory you can use:
 
@@ -18,55 +44,61 @@ mvn clean install
 to run the install target on all sub projects. This will
 put all necessary artifacts into your local repository.
 
-## Demo - TomEE
-### ⚠ some problems ⚠
-* AJAX is not working
+## Live Demo
 
-Switch to sub-directory and call Maven to run the demo:
+You can find a live demo of all components at [https://tobago-vm.apache.org/](https://tobago-vm.apache.org/)
 
-```
-cd tobago-example/tobago-example-demo
-mvn clean package tomee:run -Ptomee -Pdev
-```
+## Examples
 
-Browse to the local URL http://localhost:8080/
+See `tobago-examples` directory for some simple examples on how to use Tobago.
 
-## Demo - Jetty - MyFaces - OWB
-### ⚠ currently broken ⚠
-* Problem with CDI
 
-Switch to sub-directory and call Maven to run the demo:
+**Demo**
 
-```
-cd tobago-example/tobago-example-demo
-mvn clean jetty:run -Pjetty
+If you want to run the demo locally you need to run the following command
+
+
+```shell
+mvn -f tobago-example/tobago-example-demo/pom.xml clean package tomee:run -Ptomee -Pdev
 ```
 
 Browse to the local URL http://localhost:8080/
 
-## Demo - Jetty - Mojarra - Weld
-### ⚠ some problems ⚠
-* AJAX is not working
+You can also run the demo with different servers and JSF implementations
 
-Switch to sub-directory and call Maven to run the demo:
+**Jetty, OpenWebBeans (⚠ currently broken ⚠)**
 
+```shell
+mvn -f tobago-example/tobago-example-demo/pom.xml clean package jetty:run -Pjetty
 ```
-cd tobago-example/tobago-example-demo
-mvn clean jetty:run -Pjetty -Djsf=mojarra-3.0
-```
-
-Browse to the local URL http://localhost:8080/
 
-## Demo - Tomcat - Mojarra - Weld (in Docker)
-### ⚠ some problems ⚠
-* AJAX is not working
+**Jetty, MyFaces and OpenWebBeans**
+```shell
+mvn -f tobago-example/tobago-example-demo/pom.xml clean package jetty:run -Pjetty
+```
 
-Switch to sub-directory and call Maven to build and Docker to run the demo:
+**Jetty, Mojarra and Weld (⚠ some problems ⚠)**
+```shell
+mvn -f tobago-example/tobago-example-demo/pom.xml clean package jetty:run -Pjetty -Djsf=mojarra-3.0
+```
 
+**Tomcat, Mojarra and Weld (in Docker)**
 ```
 cd tobago-example/tobago-example-demo
 mvn clean install -Djsf=mojarra-3.0
 docker run -it --rm -p 8080:8080 -v `pwd`/target/tobago-example-demo.war:/usr/local/tomcat/webapps/tobago-example-demo.war --name tobago-example-demo tomcat:10.0-jre11
 ```
-
 Browse to the local URL http://localhost:8080/tobago-example-demo/
+
+# Issue Tracking
+
+If you find any issues regarding MyFaces Tobago you can use the [Apache Issue Tracker](https://issues.apache.org/jira/projects/TOBAGO) to report them
+
+
+# Contributing
+[Pull requests](https://help.github.com/articles/creating-a-pull-request) are welcome; see the [contributor guidelines](CONTRIBUTING.md) for details.
+
+
+# Licensing
+
+The terms for software licensing are detailed in the [LICENSE.txt](LICENSE.txt) file.