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/19 11:35:37 UTC
[camel-k-examples] 01/02: improve readme
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 9de9f12d5e3f142ca68f67ee89b99d8a8ace906e
Author: Kuthumi Pepple <ku...@gmail.com>
AuthorDate: Fri Aug 19 06:34:06 2022 +0100
improve readme
---
generic-examples/languages/README.md | 24 ++++++++++++++++++++++--
1 file changed, 22 insertions(+), 2 deletions(-)
diff --git a/generic-examples/languages/README.md b/generic-examples/languages/README.md
index 1d70af4..09a40a2 100644
--- a/generic-examples/languages/README.md
+++ b/generic-examples/languages/README.md
@@ -1,3 +1,23 @@
-# Supported languages Camel K examples
+# Supported languages for writing Camel K integrations
-Find useful examples about how to develop a Camel K integration in `Java`, `Javascript`, `Groovy`, `XML` and `YAML`.
\ No newline at end of file
+Contains useful examples on how to develop a Camel K integration in `Java`, `Javascript`, `Groovy`, `XML`, `Kotlin` and `YAML`.
+
+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
+- [routes.kts](./routes.kts): defines a route that logs a message every second
+- [routes.yaml](./hello.xml): defines a route that every 5 secs, transforms the message content to uppercase and logs it.
+- [simple.js](./simple.js): logs message periodically, the multiline query parameter is set to true, thus each information is output on a newline
+
+## Running the Examples
+To simply run an integration, execute `kamel run [file to run]`. For example:
+```
+kamel run routes.yaml
+```
\ No newline at end of file