You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2024/12/03 13:46:26 UTC

(camel-jbang-examples) branch main updated: Polished

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

davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-jbang-examples.git


The following commit(s) were added to refs/heads/main by this push:
     new a053870  Polished
a053870 is described below

commit a053870f642bf2f82ae6af7c540f08743fe3ead4
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Tue Dec 3 14:45:09 2024 +0100

    Polished
---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0652415..7406399 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,49 @@
 [Apache Camel](http://camel.apache.org/) is a powerful open source integration framework based on known
 Enterprise Integration Patterns with powerful bean integration.
 
-### Introduction
+## Introduction
 
 This project provides examples for low-code integrations with Apache Camel JBang.
+
+### Examples
+
+This git repository hosts a set of ready-to-use examples you can try to learn more about Apache Camel,
+and how Camel can be used to integrate systems. These examples are accessible for non developers, as
+they can run without having to use traditional Java compilation or build systems such as Maven or Gradle.
+
+All examples can run local on your computer from a CLI terminal by executing a few commands.
+
+These examples uses JBang as the CLI which is a great tool that makes using Java much easier.
+
+#### Installing JBang
+
+First install JBang according to https://www.jbang.dev
+
+When JBang is installed then you should be able to run from a shell:
+
+[source,sh]
+----
+$ jbang --version
+----
+
+This will output the version of JBang.
+
+To run this example you can either install Camel on JBang via:
+
+[source,sh]
+----
+$ jbang app install camel@apache/camel
+----
+
+Which allows to run Camel with `camel` as shown below.
+
+[source,sh]
+----
+$ camel --version
+----
+
+
+### Other Examples
+
+You can also find a set of various Camel JBang examples at: https://github.com/apache/camel-kamelets-examples/tree/main/jbang 
+