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/0364ff4a Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0364ff4a Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0364ff4a Branch: refs/heads/master Commit: 0364ff4a46b9bf5f58137828f0d0046e6d0378ac Parents: e2ad607 Author: gautric <gaut...@redhat.com> Authored: Wed Dec 9 18:51:46 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Thu Dec 10 07:44:58 2015 +0100 ---------------------------------------------------------------------- examples/camel-example-bam/README.md | 46 ++++++++++++++++++ examples/camel-example-bam/README.txt | 46 ------------------ examples/camel-example-box-osgi/README.md | 63 +++++++++++++++++++++++++ examples/camel-example-box-osgi/README.txt | 38 --------------- 4 files changed, 109 insertions(+), 84 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/0364ff4a/examples/camel-example-bam/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-bam/README.md b/examples/camel-example-bam/README.md new file mode 100644 index 0000000..1c10542 --- /dev/null +++ b/examples/camel-example-bam/README.md @@ -0,0 +1,46 @@ +# Camel BAM Example + +## Introduction + +This example shows how to perform Business Activity Monitoring (BAM) +with Camel. + +### Camel component used in this example + +* camel-bam +* camel-jaxb +* camel-juel + +## Build + +You will need to compile this example first: + mvn compile + +For a background in BAM see + http://camel.apache.org/bam.html + +## Run + +To run the example with Maven, type + mvn camel:run + +You can see the BAM activies defined in + src/main/java/org/apache/camel/example/bam/MyActivites.java + +To stop the example hit ctrl + c + +## Documentation + +This example is documented at + http://camel.apache.org/bam-example.html + +## 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) + +Please help us make Apache Camel better - we appreciate any feedback you may +have. Enjoy! + +------------------------ +The Camel riders! http://git-wip-us.apache.org/repos/asf/camel/blob/0364ff4a/examples/camel-example-bam/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-bam/README.txt b/examples/camel-example-bam/README.txt deleted file mode 100644 index 1c10542..0000000 --- a/examples/camel-example-bam/README.txt +++ /dev/null @@ -1,46 +0,0 @@ -# Camel BAM Example - -## Introduction - -This example shows how to perform Business Activity Monitoring (BAM) -with Camel. - -### Camel component used in this example - -* camel-bam -* camel-jaxb -* camel-juel - -## Build - -You will need to compile this example first: - mvn compile - -For a background in BAM see - http://camel.apache.org/bam.html - -## Run - -To run the example with Maven, type - mvn camel:run - -You can see the BAM activies defined in - src/main/java/org/apache/camel/example/bam/MyActivites.java - -To stop the example hit ctrl + c - -## Documentation - -This example is documented at - http://camel.apache.org/bam-example.html - -## 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) - -Please help us make Apache Camel better - we appreciate any feedback you may -have. Enjoy! - ------------------------- -The Camel riders! http://git-wip-us.apache.org/repos/asf/camel/blob/0364ff4a/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 new file mode 100644 index 0000000..2820f5b --- /dev/null +++ b/examples/camel-example-box-osgi/README.md @@ -0,0 +1,63 @@ +# Box.com OSGi Example + +## Introduction + +A simple example which sets up a camel route to upload files +found in an `inbox` directory to a box.com account. + + +## Build + +First you will need to compile the example: + mvn install + +## Run + +To run the example on Apache Karaf 2.3.x + +## Step 1 + +Launch karaf + +## Step 2 + +Add features required + + features:addUrl mvn:org.apache.camel.karaf/apache-camel/${version}/xml/features + features:install camel-spring + features:install camel-box + +## Step 3 + +Create a `box.properties` file in the Karaf base directory with the following properties +set to your box account credentials. + + box.userName= + box.userPassword= + box.clientId= + box.clientSecret= + +## Step 4 + +Deploy the example + + osgi:install -s mvn:org.apache.camel/camel-example-box-osgi/${version} + +## Step 5 + +Copy files to the `inbox` directory in the Karaf base directory. + +## Step 6 + +Watch them get transferred to your box.com account. + +## 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) + +Please help us make Apache Camel better - we appreciate any feedback you may +have. Enjoy! + +------------------------ +The Camel riders! http://git-wip-us.apache.org/repos/asf/camel/blob/0364ff4a/examples/camel-example-box-osgi/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-box-osgi/README.txt b/examples/camel-example-box-osgi/README.txt deleted file mode 100644 index 90004c5..0000000 --- a/examples/camel-example-box-osgi/README.txt +++ /dev/null @@ -1,38 +0,0 @@ -Box.com OSGi Example -==================== - -A simple example which sets up a camel route to upload files -found in an `inbox` directory to a box.com account. - -First you will need to compile the example: - mvn install - -To run the example on Apache Karaf 2.3.x - -1) launch karaf - -2) Add features required -features:addUrl mvn:org.apache.camel.karaf/apache-camel/${version}/xml/features -features:install camel-spring -features:install camel-box - -3) Create a `box.properties` file in the Karaf base directory with the following properties -set to your box account credentials. - - box.userName= - box.userPassword= - box.clientId= - box.clientSecret= - -3) Deploy the example -osgi:install -s mvn:org.apache.camel/camel-example-box-osgi/${version} - -4) Copy files to the `inbox` directory in the Karaf base directory. - -5) Watch them get transferred to your box.com account. - -Please help us make Apache Camel better - we appreciate any feedback you may -have. Enjoy! - ------------------------- -The Camel Riders!
