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/d269666f Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/d269666f Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/d269666f Branch: refs/heads/master Commit: d269666faf65f531fcaf4947c68c4b2b256908df Parents: 8569f2c Author: gautric <gaut...@redhat.com> Authored: Wed Dec 9 19:06:46 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Thu Dec 10 07:44:58 2015 +0100 ---------------------------------------------------------------------- examples/camel-example-aggregate/README.md | 8 +++-- examples/camel-example-bam/README.md | 12 ++++---- examples/camel-example-box-osgi/README.md | 7 +++-- examples/camel-example-cafe/README.md | 40 +++++++++++++++++++++++++ examples/camel-example-cafe/README.txt | 28 ----------------- 5 files changed, 56 insertions(+), 39 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/d269666f/examples/camel-example-aggregate/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-aggregate/README.md b/examples/camel-example-aggregate/README.md index 3ef3c65..8463c5c 100644 --- a/examples/camel-example-aggregate/README.md +++ b/examples/camel-example-aggregate/README.md @@ -21,14 +21,16 @@ The user can then enter more numbers to do another aggregation. The example is run using Maven. First compile the example by entering: - mvn compile + + mvn compile ### Run To run the example type: - mvn camel:run -To stop the example hit Ctrl-C. If you restart it and resume entering numbers + mvn camel:run + +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. http://git-wip-us.apache.org/repos/asf/camel/blob/d269666f/examples/camel-example-bam/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-bam/README.md b/examples/camel-example-bam/README.md index 5bff285..ccf5c5d 100644 --- a/examples/camel-example-bam/README.md +++ b/examples/camel-example-bam/README.md @@ -14,25 +14,27 @@ with Camel. ### Build You will need to compile this example first: - mvn compile + + mvn compile For a background in BAM see - http://camel.apache.org/bam.html + [http://camel.apache.org/bam.html](http://camel.apache.org/bam.html) ### Run To run the example with Maven, type - mvn camel:run + + mvn camel:run You can see the BAM activies defined in - src/main/java/org/apache/camel/example/bam/MyActivites.java + `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 + [http://camel.apache.org/bam-example.html](http://camel.apache.org/bam-example.html) ### Forum, Help, etc http://git-wip-us.apache.org/repos/asf/camel/blob/d269666f/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 803af9d..f65c735 100644 --- a/examples/camel-example-box-osgi/README.md +++ b/examples/camel-example-box-osgi/README.md @@ -13,7 +13,8 @@ found in an `inbox` directory to a box.com account. ### Build First you will need to compile the example: - mvn install + + mvn install ### Run @@ -25,7 +26,7 @@ Launch karaf #### Step 2 -Add features required +Add features required into Karak features:addUrl mvn:org.apache.camel.karaf/apache-camel/${version}/xml/features features:install camel-spring @@ -43,7 +44,7 @@ set to your box account credentials. #### Step 4 -Deploy the example +Deploy the example into Karak osgi:install -s mvn:org.apache.camel/camel-example-box-osgi/${version} http://git-wip-us.apache.org/repos/asf/camel/blob/d269666f/examples/camel-example-cafe/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-cafe/README.md b/examples/camel-example-cafe/README.md new file mode 100644 index 0000000..61c81f3 --- /dev/null +++ b/examples/camel-example-cafe/README.md @@ -0,0 +1,40 @@ +# Cafe Example + + +### Introduction + +This example shows how to work with splitter and aggregator to implement a Cafe demo. + +### Build + +You will need to compile this example first: + + mvn compile + +### Run + +To run the example type + + mvn camel:run + +You can see the routing rules by looking at the java code in the +`src/main/java directory` and the Spring XML configuration lives in +`src/main/resources/META-INF/spring` + +To stop the example hit `ctrl + c` + +### Documentation + +This example is documented at + [http://camel.apache.org/cafe-example.html](http://camel.apache.org/cafe-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/d269666f/examples/camel-example-cafe/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-cafe/README.txt b/examples/camel-example-cafe/README.txt deleted file mode 100644 index 205b834..0000000 --- a/examples/camel-example-cafe/README.txt +++ /dev/null @@ -1,28 +0,0 @@ -Cafe Example -============== - -This example shows how to work with splitter and aggregator to implement a Cafe demo. - -You will need to compile this example first: - mvn compile - -To run the example type - mvn camel:run - -You can see the routing rules by looking at the java code in the -src/main/java directory and the Spring XML configuration lives in -src/main/resources/META-INF/spring - -To stop the example hit ctrl + c - -This example is documented at - http://camel.apache.org/cafe-example.html - -If you hit any problems please talk to us on the Camel Forums - 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!
