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/5c34a315 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5c34a315 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5c34a315 Branch: refs/heads/master Commit: 5c34a3154c1e65b32e2eeda473c72863fc97dd54 Parents: 6f3e00c Author: gautric <gaut...@redhat.com> Authored: Wed Dec 9 18:43:39 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Thu Dec 10 07:44:58 2015 +0100 ---------------------------------------------------------------------- .../camel-example-activemq-tomcat/README.md | 12 +++-- examples/camel-example-aggregate/README.md | 49 ++++++++++++++++++++ examples/camel-example-aggregate/README.txt | 33 ------------- 3 files changed, 58 insertions(+), 36 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/5c34a315/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 b2f7719..0739898 100644 --- a/examples/camel-example-activemq-tomcat/README.md +++ b/examples/camel-example-activemq-tomcat/README.md @@ -14,7 +14,9 @@ This example shows how you can embed Apache ActiveMQ Broker and Camel in a web a You will need to build this example first: mvn install - + +## Run + Which will create a `.war` file in the target directly. You can then deploy this `.war` file in any web container such as @@ -25,12 +27,16 @@ 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. -This example is documented at - [http://camel.apache.org/activemq-camel-tomcat.html](http://camel.apache.org/activemq-camel-tomcat.html) +## 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 + +This example is documented at + [http://camel.apache.org/activemq-camel-tomcat.html](http://camel.apache.org/activemq-camel-tomcat.html) + ## Forum, Help, etc If you hit an problems please let us know on the Camel Forums http://git-wip-us.apache.org/repos/asf/camel/blob/5c34a315/examples/camel-example-aggregate/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-aggregate/README.md b/examples/camel-example-aggregate/README.md new file mode 100644 index 0000000..1518d76 --- /dev/null +++ b/examples/camel-example-aggregate/README.md @@ -0,0 +1,49 @@ +# Camel Persistent Aggregate + +## Introduction + +This example shows how to use Camel Aggregator EIP which offers (since Camel 2.3) +database persistence. + +It's an interactive example where you can type in some numbers which then are aggregated +(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-core +* camel-hawtdb +* camel-spring +* camel-stream + +## Build + +The example is run using Maven. + +First compile the example by entering: + 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 +you should see that it remembered previously entered values, as it +uses a persistent store. + +## Documentation + +This example is documented at + [http://camel.apache.org/aggregate-example.html](http://camel.apache.org/aggregate-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! \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/5c34a315/examples/camel-example-aggregate/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-aggregate/README.txt b/examples/camel-example-aggregate/README.txt deleted file mode 100644 index 7b89bd6..0000000 --- a/examples/camel-example-aggregate/README.txt +++ /dev/null @@ -1,33 +0,0 @@ -Camel Persistent Aggregate -========================== - -This example shows how to use Camel Aggregator EIP which offers (since Camel 2.3) -database persistence. - -It's an interactive example where you can type in some numbers which then are aggregated -(summed, per this sample's aggregation strategy) whenever the user types STOP. -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 - -To run the example type: - 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. - -If you hit any problems please let us know on the Camel Forums - http://camel.apache.org/discussion-forums.html - -This example is documented at - http://camel.apache.org/aggregate-example.html - -Please help us make Apache Camel better - we appreciate any feedback you may -have. Enjoy! - ------------------------- -The Camel Riders!