CAMEL-9337 Add readme.txt to all examples
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/8569f2cb Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/8569f2cb Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/8569f2cb Branch: refs/heads/master Commit: 8569f2cb9a9b2c65bac7e473ba6fca35589da53b Parents: 0364ff4 Author: gautric <gaut...@redhat.com> Authored: Wed Dec 9 18:58:57 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Thu Dec 10 07:44:58 2015 +0100 ---------------------------------------------------------------------- .../camel-example-activemq-tomcat/README.md | 14 ++++++------ examples/camel-example-aggregate/README.md | 12 +++++----- examples/camel-example-bam/README.md | 12 +++++----- examples/camel-example-box-osgi/README.md | 24 ++++++++++++-------- 4 files changed, 33 insertions(+), 29 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/8569f2cb/examples/camel-example-activemq-tomcat/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-activemq-tomcat/README.md b/examples/camel-example-activemq-tomcat/README.md index 0739898..315a962 100644 --- a/examples/camel-example-activemq-tomcat/README.md +++ b/examples/camel-example-activemq-tomcat/README.md @@ -1,21 +1,21 @@ # Embedded ActiveMQ Broker with Camel running in Apache Tomcat -## Introduction +### Introduction This example shows how you can embed Apache ActiveMQ Broker and Camel in a web application, which can run on Apache Tomcat or other web containers. -### Camel component used in this example +#### Camel component used in this example * camel-core * camel-jms * camel-spring -## Build +### Build You will need to build this example first: mvn install -## Run +### Run Which will create a `.war` file in the target directly. @@ -27,17 +27,17 @@ which will continuously send a message per second to an inbox queue. Then another Camel route will route messages from the inbox to the outbox queue. -## Configuration +### Configuration The ActiveMQ broker is configured in the `src/main/resources/broker.xml` file. And the Camel application in the `src/main/resources/camel-context.xml` file. -## Documentation +### Documentation This example is documented at [http://camel.apache.org/activemq-camel-tomcat.html](http://camel.apache.org/activemq-camel-tomcat.html) -## Forum, Help, etc +### Forum, Help, etc If you hit an problems please let us know on the Camel Forums [http://camel.apache.org/discussion-forums.html](http://camel.apache.org/discussion-forums.html) http://git-wip-us.apache.org/repos/asf/camel/blob/8569f2cb/examples/camel-example-aggregate/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-aggregate/README.md b/examples/camel-example-aggregate/README.md index 1518d76..3ef3c65 100644 --- a/examples/camel-example-aggregate/README.md +++ b/examples/camel-example-aggregate/README.md @@ -1,6 +1,6 @@ # Camel Persistent Aggregate -## Introduction +### Introduction This example shows how to use Camel Aggregator EIP which offers (since Camel 2.3) database persistence. @@ -9,21 +9,21 @@ It's an interactive example where you can type in some numbers which then are ag (summed, per this sample's aggregation strategy) whenever the user types STOP. The user can then enter more numbers to do another aggregation. -### Camel component used in this example +#### Camel component used in this example * camel-core * camel-hawtdb * camel-spring * camel-stream -## Build +### Build The example is run using Maven. First compile the example by entering: mvn compile -## Run +### Run To run the example type: mvn camel:run @@ -32,12 +32,12 @@ To stop the example hit Ctrl-C. If you restart it and resume entering numbers you should see that it remembered previously entered values, as it uses a persistent store. -## Documentation +### Documentation This example is documented at [http://camel.apache.org/aggregate-example.html](http://camel.apache.org/aggregate-example.html) -## Forum, Help, etc +### Forum, Help, etc If you hit an problems please let us know on the Camel Forums [http://camel.apache.org/discussion-forums.html](http://camel.apache.org/discussion-forums.html) http://git-wip-us.apache.org/repos/asf/camel/blob/8569f2cb/examples/camel-example-bam/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-bam/README.md b/examples/camel-example-bam/README.md index 1c10542..5bff285 100644 --- a/examples/camel-example-bam/README.md +++ b/examples/camel-example-bam/README.md @@ -1,17 +1,17 @@ # Camel BAM Example -## Introduction +### Introduction This example shows how to perform Business Activity Monitoring (BAM) with Camel. -### Camel component used in this example +#### Camel component used in this example * camel-bam * camel-jaxb * camel-juel -## Build +### Build You will need to compile this example first: mvn compile @@ -19,7 +19,7 @@ You will need to compile this example first: For a background in BAM see http://camel.apache.org/bam.html -## Run +### Run To run the example with Maven, type mvn camel:run @@ -29,12 +29,12 @@ You can see the BAM activies defined in To stop the example hit ctrl + c -## Documentation +### Documentation This example is documented at http://camel.apache.org/bam-example.html -## Forum, Help, etc +### Forum, Help, etc If you hit an problems please let us know on the Camel Forums [http://camel.apache.org/discussion-forums.html](http://camel.apache.org/discussion-forums.html) http://git-wip-us.apache.org/repos/asf/camel/blob/8569f2cb/examples/camel-example-box-osgi/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-box-osgi/README.md b/examples/camel-example-box-osgi/README.md index 2820f5b..803af9d 100644 --- a/examples/camel-example-box-osgi/README.md +++ b/examples/camel-example-box-osgi/README.md @@ -1,25 +1,29 @@ # Box.com OSGi Example -## Introduction +### Introduction A simple example which sets up a camel route to upload files found in an `inbox` directory to a box.com account. +#### Camel component used in this example -## Build +* camel-code +* camel-bom + +### Build First you will need to compile the example: mvn install -## Run +### Run To run the example on Apache Karaf 2.3.x -## Step 1 +#### Step 1 Launch karaf -## Step 2 +#### Step 2 Add features required @@ -27,7 +31,7 @@ Add features required features:install camel-spring features:install camel-box -## Step 3 +#### Step 3 Create a `box.properties` file in the Karaf base directory with the following properties set to your box account credentials. @@ -37,21 +41,21 @@ set to your box account credentials. box.clientId= box.clientSecret= -## Step 4 +#### Step 4 Deploy the example osgi:install -s mvn:org.apache.camel/camel-example-box-osgi/${version} -## Step 5 +#### Step 5 Copy files to the `inbox` directory in the Karaf base directory. -## Step 6 +#### Step 6 Watch them get transferred to your box.com account. -## Forum, Help, etc +### Forum, Help, etc If you hit an problems please let us know on the Camel Forums [http://camel.apache.org/discussion-forums.html](http://camel.apache.org/discussion-forums.html)
