You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ts...@apache.org on 2022/08/22 03:29:55 UTC

[camel-k-examples] 10/10: provide more info and context for kamelet examples

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

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

commit 27d3f1513233559a5af2136650054fbbb150fe54
Author: Kuthumi Pepple <ku...@gmail.com>
AuthorDate: Sat Aug 20 11:13:16 2022 +0100

    provide more info and context for kamelet examples
---
 generic-examples/kamelets/README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/generic-examples/kamelets/README.md b/generic-examples/kamelets/README.md
index 819f173..f0f2a5c 100644
--- a/generic-examples/kamelets/README.md
+++ b/generic-examples/kamelets/README.md
@@ -1,3 +1,29 @@
 # Kamelets Camel K examples
 
-Find useful examples about how to use Kamelets.
\ No newline at end of file
+Find useful examples about how to use Kamelets.
+
+To learn more about Kamelets, see the [Kamelets Guide](https://camel.apache.org/camel-k/next/kamelets/kamelets.html) <br>
+You can find more information about Apache Camel and Apache Camel K on the [official Camel website](https://camel.apache.org)
+
+## Before you begin
+
+Read the general instructions in the [root README.md file](/README.md) for setting up your environment and the Kubernetes cluster before looking at this example.
+
+Make sure you've read the [installation instructions](https://camel.apache.org/camel-k/latest/installation/installation.html) for your specific
+cluster before starting the example.
+
+## Understanding the Examples
+The examples are grouped into the following sub-directories:
+- [chuck-norris](./chuck-norris/): contains quick demonstration on how to use an already existing kamelet in a Camel application.
+- [error-handler](./error-handler/): contains examples on how to:
+    - create event source kamelet and sink kamelet
+    - bind the source and sink kamelets using KameletBinding
+    - handle error arising from sending events
+- [kameletbindings](./kameletbindings/): contains more examples on KamletBindings and how to use `traits` to customize your integration.
+- [timer-source](./timer-source/): contains examples on how to: 
+    - create and use a timer source kamelet
+    - bind a source kamelet to a Knative destination using KamletBinding
+- [timer-source-log-sink](./timer-source-log-sink/): 
+    - create and use a timer source kamelet
+    - bind a source kamelet to a Knative destination using KamletBinding
+    - create a log sink kamlet and bind it to the Knative destination using KamletBinding
\ No newline at end of file