[camel-kameleon] branch main updated: Initial README

[da...@apache.org]

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-kameleon.git


The following commit(s) were added to refs/heads/main by this push:
     new 960bd87  Initial README
     new 75617d4  Merge pull request #1 from mgubaidullin/initial-readme
960bd87 is described below

commit 960bd873bde7e6dcdbea8012520a26e5cea0bd3c
Author: Marat Gubaidullin <ma...@gmail.com>
AuthorDate: Fri Jul 9 17:00:43 2021 -0400

    Initial README
---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4a8136f..5a6daec 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,39 @@
-# kameleon 
+# Kameleon - project scaffolding for Apache Camel
+
+This is a project generator for Apache Camel. It generates maven-based Java project with preconfigured Apache Camel runtime and selected components/extensions.
+
+## Build and run locally 
+### Prerequisites
+- Java 11
+- Maven 3.6
+- Git
+
+### Install camel-kamelets-catalog
+Kameleon requires camel-kamelets-catalog that is not in maven central yet.
+```bash
+cd /tmp/camel
+git clone git@github.com:apache/camel-kamelets.git 
+mvn install   
+```
+
+### Run in development mode
+```bash
+export MAVEN_HOME=$YOUR_MAVEN_HOME ; mvn quarkus:dev
+```
+
+### Build 
+```bash
+mvn package
+```
+
+### Run 
+```bash
+export MAVEN_HOME=$YOUR_MAVEN_HOME ; java -jar target/kameleon/kameleon-0.2.0-runner.jar
+```
+
+
+## Start locally
+Start the latest image locally:
+```bash
+docker run -i --rm -p 8080:8080 ghcr.io/apache/camel-kameleon:latest
+```