[camel-k-examples] 01/03: add context to basic example

[ts...@apache.org]

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 765dbce1a5c2f576a591033f99c15aa729d1a644
Author: Kuthumi Pepple <ku...@gmail.com>
AuthorDate: Sat Jun 25 01:00:02 2022 +0100

    add context to basic example
---
 generic-examples/basic/README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/generic-examples/basic/README.md b/generic-examples/basic/README.md
index 9bdef5c..7621e62 100644
--- a/generic-examples/basic/README.md
+++ b/generic-examples/basic/README.md
@@ -1,3 +1,24 @@
 # Camel K basic examples
 
-Find useful examples about how to run an integration in Camel K.
\ No newline at end of file
+This example shows how to set an env variable to be used in a Camel K integration.
+
+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 Example
+
+- [`Env.java`](./Env.java) defines a route that logs the value of an env variable every second
+
+## Running the Example
+
+To both set the `MY_ENV_VAR` env variable to `hello world` and run the integration, execute the following:
+```
+kamel run --env MY_ENV_VAR="hello world" Env.java --dev
+```
+You should see `hello world` logged to the terminal every second
\ No newline at end of file