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/6a018a96 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6a018a96 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6a018a96 Branch: refs/heads/master Commit: 6a018a9695e86389d5b91167b671968bfbe60626 Parents: d269666 Author: gautric <[email protected]> Authored: Wed Dec 9 19:12:52 2015 +0100 Committer: Claus Ibsen <[email protected]> Committed: Thu Dec 10 07:44:59 2015 +0100 ---------------------------------------------------------------------- examples/camel-example-cdi/README.md | 39 +++++++++++++++++++++++ examples/camel-example-cdi/README.txt | 31 ------------------ examples/camel-example-console/README.md | 40 +++++++++++++++++++++++ examples/camel-example-console/README.txt | 31 ------------------ examples/camel-example-cxf/README.md | 44 ++++++++++++++++++++++++++ examples/camel-example-cxf/README.txt | 31 ------------------ 6 files changed, 123 insertions(+), 93 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/6a018a96/examples/camel-example-cdi/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-cdi/README.md b/examples/camel-example-cdi/README.md new file mode 100644 index 0000000..d5e64d7 --- /dev/null +++ b/examples/camel-example-cdi/README.md @@ -0,0 +1,39 @@ +# CDI Example + +### Introduction + +This example shows how to work with Camel using CDI to configure components, +endpoints and beans. + +A timer triggers a Camel route to run every 5th second which creates a message that is logged to the console. + +### 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 + + To stop the example hit `ctrl + c` + +When we launch the example using the camel maven plugin, a local CDI container +is created and started. + +### 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/6a018a96/examples/camel-example-cdi/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-cdi/README.txt b/examples/camel-example-cdi/README.txt deleted file mode 100644 index d0978cc..0000000 --- a/examples/camel-example-cdi/README.txt +++ /dev/null @@ -1,31 +0,0 @@ -CDI Example -=========== - -This example shows how to work with Camel using CDI to configure components, -endpoints and beans. - -A timer triggers a Camel route to run every 5th second which creates a message that is logged to the console. - -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 - - To stop the example hit ctrl + c - -When we launch the example using the camel maven plugin, a local CDI container -is created and started. - -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! http://git-wip-us.apache.org/repos/asf/camel/blob/6a018a96/examples/camel-example-console/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-console/README.md b/examples/camel-example-console/README.md new file mode 100644 index 0000000..5d7a384 --- /dev/null +++ b/examples/camel-example-console/README.md @@ -0,0 +1,40 @@ +# Camel Console Example + +### Introduction + +This is a simple example that shows how to get started with Camel. + +### 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 XML in the directory: + `src/main/resources/META-INF/spring` + +To stop the example hit `ctrl + c` + +You can also run the example from your editor such as Eclipse, IDEA etc, +by opening the org.apache.camel.example.console.CamelConsoleMain class +and then right click, and chose run java application. + +### Documentation + +This example is documented at [http://camel.apache.org/console-example.html](http://camel.apache.org/console-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/6a018a96/examples/camel-example-console/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-console/README.txt b/examples/camel-example-console/README.txt deleted file mode 100644 index 7002036..0000000 --- a/examples/camel-example-console/README.txt +++ /dev/null @@ -1,31 +0,0 @@ -Console Example -=============== - -This is a simple example that shows how to get started with Camel. - -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 XML in the directory: - src/main/resources/META-INF/spring - -To stop the example hit ctrl + c - -You can also run the example from your editor such as Eclipse, IDEA etc, -by opening the org.apache.camel.example.console.CamelConsoleMain class -and then right click, and chose run java application. - -This example is documented at - http://camel.apache.org/console-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! http://git-wip-us.apache.org/repos/asf/camel/blob/6a018a96/examples/camel-example-cxf/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-cxf/README.md b/examples/camel-example-cxf/README.md new file mode 100644 index 0000000..3d9d57c --- /dev/null +++ b/examples/camel-example-cxf/README.md @@ -0,0 +1,44 @@ +# Camel CXF Example + +### Introduction + +This example shows how to work with CXF and Camel. + +### Build + +You will need to compile this example first: + + mvn compile + +### Run + +To run the example of routing between different transport type + + mvn exec:java -PHttpToJMS + +To run the example of Camel transport type + + mvn exec:java -PCamelTransport + +To run the example of using WebServiceProvider API + + mvn exec:java -PWebServiceProvider + +To run the example of showing how to create CXF JAXRS endpoint + + mvn exec:java -PJAXRS + +### Documentation + +This example is documented at [http://camel.apache.org/cxf-example.html](http://camel.apache.org/cxf-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/6a018a96/examples/camel-example-cxf/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-cxf/README.txt b/examples/camel-example-cxf/README.txt deleted file mode 100644 index 4fe01fb..0000000 --- a/examples/camel-example-cxf/README.txt +++ /dev/null @@ -1,31 +0,0 @@ -CXF Example -=========== - -This example shows how to work with CXF and Camel. - -You will need to compile this example first: - mvn compile - -To run the example of routing between different transport type - mvn exec:java -PHttpToJMS - -To run the example of Camel transport type - mvn exec:java -PCamelTransport - -To run the example of using WebServiceProvider API - mvn exec:java -PWebServiceProvider - -To run the example of showing how to create CXF JAXRS endpoint - mvn exec:java -PJAXRS - -This example is documented at - http://camel.apache.org/cxf-example.html - -If you hit any problems please let us know 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!
