You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2015/12/10 07:46:00 UTC
[16/16] camel git commit: CAMEL-9337 Add readme.txt to all examples
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/3b7abcce
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/3b7abcce
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/3b7abcce
Branch: refs/heads/master
Commit: 3b7abcceaf547c5e2e3eda40dfa39b254ff2a0fb
Parents: eea1c44
Author: gautric <ga...@redhat.com>
Authored: Wed Dec 9 22:10:34 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Dec 10 07:45:01 2015 +0100
----------------------------------------------------------------------
examples/README.md | 6 +-
examples/camel-example-jmx/README.md | 39 ++++++++++
examples/camel-example-jmx/README.txt | 32 --------
examples/camel-example-loadbalancing/README.md | 55 ++++++++++++++
examples/camel-example-loadbalancing/README.txt | 50 -------------
examples/camel-example-loan-broker/README.md | 41 +++++++++++
examples/camel-example-loan-broker/README.txt | 34 ---------
examples/camel-example-management/README.md | 77 ++++++++++++++++++++
examples/camel-example-management/README.txt | 69 ------------------
examples/camel-example-mybatis/README.md | 53 ++++++++++++++
examples/camel-example-mybatis/README.txt | 44 -----------
examples/camel-example-netty-http/README.md | 68 +++++++++++++++++
examples/camel-example-netty-http/README.txt | 55 --------------
examples/camel-example-osgi-rmi/README.md | 51 +++++++++++++
examples/camel-example-osgi-rmi/README.txt | 39 ----------
examples/camel-example-osgi/README.md | 45 ++++++++++++
examples/camel-example-osgi/README.txt | 46 ------------
17 files changed, 432 insertions(+), 372 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/README.md
----------------------------------------------------------------------
diff --git a/examples/README.md b/examples/README.md
index 35a87ac..d8d65a3 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -10,13 +10,13 @@ View the individual example READMEs for details.
### Documentation
-They are described in detail here [http://camel.apache.org/examples.html](http://camel.apache.org/examples.html)
+They are described in detail here <http://camel.apache.org/examples.html>
-Before you start we recommend you install a recent distribution of Maven, which we use to run our examples [http://maven.apache.org/](http://maven.apache.org/)
+Before you start we recommend you install a recent distribution of Maven, which we use to run our examples <http://maven.apache.org/>
### 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)
+If you hit an 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!
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-jmx/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-jmx/README.md b/examples/camel-example-jmx/README.md
new file mode 100644
index 0000000..fde6edf
--- /dev/null
+++ b/examples/camel-example-jmx/README.md
@@ -0,0 +1,39 @@
+# JMX Example
+
+### Introduction
+
+This example shows how to work with the Camel-JMX component.
+
+The example creates a simple MBean, registers a route to listen for
+notification events on that bean and creates another route that calls
+the MBean.
+
+### Build
+
+You will need to compile this example first:
+
+ mvn compile
+
+### 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`
+
+### Documentation
+
+This example is documented at [http://camel.apache.org/jmx-component-example.html](http://camel.apache.org/jmx-component-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!
+
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-jmx/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-jmx/README.txt b/examples/camel-example-jmx/README.txt
deleted file mode 100644
index 23cdc7b..0000000
--- a/examples/camel-example-jmx/README.txt
+++ /dev/null
@@ -1,32 +0,0 @@
-JMX Example
-===========
-
-This example shows how to work with the Camel-JMX component.
-
-The example creates a simple MBean, registers a route to listen for
-notification events on that bean and creates another route that calls
-the MBean.
-
-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/jmx-component-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/3b7abcce/examples/camel-example-loadbalancing/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-loadbalancing/README.md b/examples/camel-example-loadbalancing/README.md
new file mode 100644
index 0000000..a4f1bba
--- /dev/null
+++ b/examples/camel-example-loadbalancing/README.md
@@ -0,0 +1,55 @@
+# Load balancing with MINA Example
+
+
+### Introduction
+
+This example shows how you can easily use the Camel-MINA component to design a solution
+allowing for distributing message workload onto several servers.
+These servers are simple TCP/IP servers created by the Apache MINA framework and run in
+separate JVMs. The load balancer pattern of Camel which is used on top of them allows for
+sending in Round Robin mode the messages created from a Camel Bean component
+alternatively between each server running on localhost:9991 and localhost:9992.
+
+Within this demo every ten seconds, a Report object is created from the Camel load balancer server.
+This object is sent by the Camel load balancer to a MINA server where the object is then serialized.
+One of the two MINA servers (localhost:9991 and localhost:9992) receives the object and enriches
+the message by setting the field reply of the Report object. The reply is sent back by the MINA
+server to the client, which then logs the reply on the console.
+
+If any of the two MINA servers is not running, then the load balancer will automatic failover
+to the next server.
+
+### Build
+
+To compile and install the project in your maven repo, execute the following
+command on the root of the project
+
+ mvn clean install
+
+### Run
+
+To run the example, then execute the following command in the respective folder:
+
+>mina1
+
+ mvn exec:java -Pmina1
+
+>mina2
+
+ mvn exec:java -Pmina2
+
+>loadbalancing
+
+ mvn exec:java -Ploadbalancer
+
+### Documentation
+
+This example is documented at
+ <http://camel.apache.org/loadbalancing-mina-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>
+
+Please help us make Apache Camel better - we appreciate any feedback you may
+have. Enjoy!
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-loadbalancing/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-loadbalancing/README.txt b/examples/camel-example-loadbalancing/README.txt
deleted file mode 100644
index bb48641..0000000
--- a/examples/camel-example-loadbalancing/README.txt
+++ /dev/null
@@ -1,50 +0,0 @@
-Load balancing with MINA Example
-================================
-
-This example shows how you can easily use the Camel-MINA component to design a solution
-allowing for distributing message workload onto several servers.
-These servers are simple TCP/IP servers created by the Apache MINA framework and run in
-separate JVMs. The load balancer pattern of Camel which is used on top of them allows for
-sending in Round Robin mode the messages created from a Camel Bean component
-alternatively between each server running on localhost:9991 and localhost:9992.
-
-Within this demo every ten seconds, a Report object is created from the Camel load balancer server.
-This object is sent by the Camel load balancer to a MINA server where the object is then serialized.
-One of the two MINA servers (localhost:9991 and localhost:9992) receives the object and enriches
-the message by setting the field reply of the Report object. The reply is sent back by the MINA
-server to the client, which then logs the reply on the console.
-
-If any of the two MINA servers is not running, then the load balancer will automatic failover
-to the next server.
-
-Running the example
-===================
-
-To compile and install the project in your maven repo, execute the following
-command on the root of the project
-
-mvn clean install
-
-To run the example, then execute the following command in the respective folder:
-
->mina1
-mvn exec:java -Pmina1
-
->mina2
-mvn exec:java -Pmina2
-
->loadbalancing
-mvn exec:java -Ploadbalancer
-
-
-This example is documented at
- http://camel.apache.org/loadbalancing-mina-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!
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-loan-broker/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-loan-broker/README.md b/examples/camel-example-loan-broker/README.md
new file mode 100644
index 0000000..9b77a84
--- /dev/null
+++ b/examples/camel-example-loan-broker/README.md
@@ -0,0 +1,41 @@
+# Loan Broker Example
+
+### Introduction
+This example shows how to use Camel to implement the EIP's loan broker example,
+from the EIP book (http://www.enterpriseintegrationpatterns.com/SystemManagementExample.html).
+
+The example has two versions (JMS queues, and web services),
+that uses a different transport for exchanging messages between
+the client, credit agency, and the banks.
+
+### Build
+
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+
+The example of JMS queue version should run if you type
+
+ mvn exec:java -PQueue.LoanBroker
+ mvn exec:java -PQueue.Client
+
+The example of web services version
+
+ mvn exec:java -PWS.LoanBroker
+ mvn exec:java -PWS.Client
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+
+This example is documented at
+ <http://camel.apache.org/loan-broker-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>
+
+Please help us make Apache Camel better - we appreciate any feedback you may
+have. Enjoy!
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-loan-broker/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-loan-broker/README.txt b/examples/camel-example-loan-broker/README.txt
deleted file mode 100644
index 37727c6..0000000
--- a/examples/camel-example-loan-broker/README.txt
+++ /dev/null
@@ -1,34 +0,0 @@
-Loan Broker Example
-====================
-
-This example shows how to use Camel to implement the EIP's loan broker example,
-from the EIP book (http://www.enterpriseintegrationpatterns.com/SystemManagementExample.html).
-
-The example has two versions (JMS queues, and web services),
-that uses a different transport for exchanging messages between
-the client, credit agency, and the banks.
-
-You will need to compile this example first:
- mvn compile
-
-The example of JMS queue version should run if you type
- mvn exec:java -PQueue.LoanBroker
- mvn exec:java -PQueue.Client
-
-The example of web services version
- mvn exec:java -PWS.LoanBroker
- mvn exec:java -PWS.Client
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/loan-broker-example.html
-
-If you hit an 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!
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-management/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-management/README.md b/examples/camel-example-management/README.md
new file mode 100644
index 0000000..d4a3656
--- /dev/null
+++ b/examples/camel-example-management/README.md
@@ -0,0 +1,77 @@
+# Camel JMX Management
+
+### Introduction
+
+This example shows how to manage Camel using JMX (with jconsole)
+
+The example uses a timer to every 5th second to generate a file with 100 stock quotes.
+
+Another route uses a file consumer to read the files and split the file and send every single
+stock quote to a JMS queue.
+
+Then a third route consumes from this JMS queue and simulate a little CPU heavy work (by delaying)
+before the data is transformed and logged. The logger will log the progress by logging how
+long time it takes to process 100 messages.
+
+Now the idea is to use the Camel JMX management to be able to adjust this during runtime.
+What it allows you to do is to improve the performance of this example.
+
+At first there is a throttler that will throttle how fast Camel sends message to the JMS queue.
+For starters you can change this at runtime from the default 10 msg/sec to 500 msg/sec etc.
+This is done by changing the JMX attribute maximumRequestsPerPeriod on the throttler in the /producer group.
+
+The next issue is that the JMS consumer now cannot catch up and you should see that the number of messages
+on the JMS queue grows a little by little. You can find the queue from the ActiveMQ mbean and drill down under /queues.
+
+If this goes a bit to slow you can increase the first route in Camel to produce files faster. This is done by
+changing the period in the timer endpoint from 5000 to let say 2000. Before this takes effect you have to
+restart the timer consumer. So find the timer consumer and invoke the stop and start JMX operation.
+
+Now you should see the messages start to pile up in the JMS queue.
+What we do next is to increase the number of concurrent consumers. To do that you have to set this on the JMS
+endpoint. Set the concurrentConsumers from 1 to 20. And just as the timer consumer this only takes effect when
+the JMS consumer is restarted. So do a stop and start operation.
+
+What you should see is that Camel should be able to process the files much faster now and the logger should
+output a higher throughput.
+
+### Build
+
+You will need to compile this example first:
+
+ mvn compile
+
+
+### Run
+
+To run the example type
+
+ mvn camel:run
+
+To use jconsole type
+
+ jconsole
+
+And you should be able to see a process id in the connect to agent tab.
+If its there then click in and you should be connected to the Camel application.
+If its missing you can click on the advanced tab and type in JMX URL:
+ `service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi/camel`
+ (some older versions of Java does not list the local processes)
+
+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/management-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>
+
+Please help us make Apache Camel better - we appreciate any feedback you may
+have. Enjoy!
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-management/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-management/README.txt b/examples/camel-example-management/README.txt
deleted file mode 100644
index a748d77..0000000
--- a/examples/camel-example-management/README.txt
+++ /dev/null
@@ -1,69 +0,0 @@
-Camel JMX Management
-====================
-
-This example shows how to manage Camel using JMX (with jconsole)
-
-The example uses a timer to every 5th second to generate a file with 100 stock quotes.
-
-Another route uses a file consumer to read the files and split the file and send every single
-stock quote to a JMS queue.
-
-Then a third route consumes from this JMS queue and simulate a little CPU heavy work (by delaying)
-before the data is transformed and logged. The logger will log the progress by logging how
-long time it takes to process 100 messages.
-
-Now the idea is to use the Camel JMX management to be able to adjust this during runtime.
-What it allows you to do is to improve the performance of this example.
-
-At first there is a throttler that will throttle how fast Camel sends message to the JMS queue.
-For starters you can change this at runtime from the default 10 msg/sec to 500 msg/sec etc.
-This is done by changing the JMX attribute maximumRequestsPerPeriod on the throttler in the /producer group.
-
-The next issue is that the JMS consumer now cannot catch up and you should see that the number of messages
-on the JMS queue grows a little by little. You can find the queue from the ActiveMQ mbean and drill down under /queues.
-
-If this goes a bit to slow you can increase the first route in Camel to produce files faster. This is done by
-changing the period in the timer endpoint from 5000 to let say 2000. Before this takes effect you have to
-restart the timer consumer. So find the timer consumer and invoke the stop and start JMX operation.
-
-Now you should see the messages start to pile up in the JMS queue.
-What we do next is to increase the number of concurrent consumers. To do that you have to set this on the JMS
-endpoint. Set the concurrentConsumers from 1 to 20. And just as the timer consumer this only takes effect when
-the JMS consumer is restarted. So do a stop and start operation.
-
-What you should see is that Camel should be able to process the files much faster now and the logger should
-output a higher throughput.
-
-You will need to compile this example first:
- mvn compile
-
-To run the example type
- mvn camel:run
-
-To use jconsole type
- jconsole
-
-And you should be able to see a process id in the connect to agent tab.
-If its there then click in and you should be connected to the Camel application.
-If its missing you can click on the advanced tab and type in JMX URL:
- service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi/camel
- (some older versions of Java does not list the local processes)
-
-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/management-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/3b7abcce/examples/camel-example-mybatis/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-mybatis/README.md b/examples/camel-example-mybatis/README.md
new file mode 100644
index 0000000..4d1b461
--- /dev/null
+++ b/examples/camel-example-mybatis/README.md
@@ -0,0 +1,53 @@
+# Camel MyBatis Example
+
+### Introduction
+
+This example shows how to exchange data using a shared database table.
+
+The example has two Camel routes. The first route insert new data into the table,
+triggered by a timer to run every 5th second.
+
+The second route pickup the newly inserted rows from the table,
+process the row(s), and mark the row(s) as processed when done;
+to avoid picking up the same rows again.
+
+### Build
+
+You will need to install this example first to your local maven repository with:
+
+ mvn install
+
+### Run
+
+This example requires running in Apache Karaf / ServiceMix
+
+You can install this example from the shell using this example's `features.xml`
+for easy provisioning.
+
+ features:addUrl mvn:org.apache.camel/camel-example-mybatis/${version}/xml/features
+ features:install camel-example-mybatis
+
+And you can see the application running by tailing the logs
+
+ log:tail
+
+And you can use `ctrl + c` to stop tailing the log.
+
+### Configuration
+
+This example uses OSGi Blueprint to setup and configure the database,
+as well the CamelContext. You can see this in the following file:
+In the `src/main/resources/OSGI-INF/blueprint/camel-mybatis.xml`
+
+
+### Documentation
+
+This example is documented at
+ <http://camel.apache.org/mybatis-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>
+
+Please help us make Apache Camel better - we appreciate any feedback you may
+have. Enjoy!
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-mybatis/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-mybatis/README.txt b/examples/camel-example-mybatis/README.txt
deleted file mode 100644
index e7dd342..0000000
--- a/examples/camel-example-mybatis/README.txt
+++ /dev/null
@@ -1,44 +0,0 @@
-Camel MyBatis Example
-=====================
-
-This example shows how to exchange data using a shared database table.
-
-The example has two Camel routes. The first route insert new data into the table,
-triggered by a timer to run every 5th second.
-
-The second route pickup the newly inserted rows from the table,
-process the row(s), and mark the row(s) as processed when done;
-to avoid picking up the same rows again.
-
-You will need to install this example first to your local maven repository with:
- mvn install
-
-This example requires running in Apache Karaf / ServiceMix
-
-You can install this example from the shell using this example's "features.xml"
-for easy provisioning.
-
- features:addUrl mvn:org.apache.camel/camel-example-mybatis/${version}/xml/features
- features:install camel-example-mybatis
-
-And you can see the application running by tailing the logs
-
- log:tail
-
-And you can use ctrl + c to stop tailing the log.
-
-This example uses OSGi Blueprint to setup and configure the database,
-as well the CamelContext. You can see this in the following file:
-In the src/main/resources/OSGI-INF/blueprint/camel-mybatis.xml
-
-This example is documented at
- http://camel.apache.org/mybatis-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/3b7abcce/examples/camel-example-netty-http/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-netty-http/README.md b/examples/camel-example-netty-http/README.md
new file mode 100644
index 0000000..72ecf55
--- /dev/null
+++ b/examples/camel-example-netty-http/README.md
@@ -0,0 +1,68 @@
+# Camel Netty HTTP Server Example
+
+### Introduction
+
+This example shows how to use a shared Netty HTTP Server in an OSGi environment.
+
+There is 3 modules in this example
+
+* shared-netty-http-server - The Shared Netty HTTP server that the other Camel applications uses.
+* myapp-one - A Camel application that reuses the shared Netty HTTP server
+* myapp-two - A Camel application that reuses the shared Netty HTTP server
+
+
+### Build
+
+You will need to compile and prepared this example first:
+
+ mvn install
+
+### Run
+
+
+This example requires running in Apache Karaf / ServiceMix
+
+To install Apache Camel in Karaf you type in the shell (we use version 2.12.0):
+
+ features:chooseurl camel 2.12.0
+ features:install camel
+
+First you need to install the following features in Karaf/ServiceMix with:
+
+ features:install camel-netty-http
+
+Then you can install the shared Netty HTTP server which by default runs on port `8888`.
+The port number can be changed by editing the following source file:
+
+ `shared-netty-http-server/src/main/resources/OSGI-INF/blueprint/http-server.xml`
+
+In the Apache Karaf / ServiceMix shell type:
+
+ osgi:install -s mvn:org.apache.camel/camel-example-netty-http-shared/2.12.0
+
+Then you can install the Camel applications:
+
+ osgi:install -s mvn:org.apache.camel/camel-example-netty-myapp-one/2.12.0
+ osgi:install -s mvn:org.apache.camel/camel-example-netty-myapp-two/2.12.0
+
+From a web browser you can then try the example by accessing the followign URLs:
+
+<http://localhost:8888/one>
+
+<http://localhost:8888/two>
+
+This example is documented at
+ http://camel.apache.org/netty-http-server-example.html
+
+### Documentation
+
+This example is documented at
+ <http://camel.apache.org/netty-http-server-example.htmll>
+
+### Forum, Help, etc
+
+If you hit an 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!
+
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-netty-http/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-netty-http/README.txt b/examples/camel-example-netty-http/README.txt
deleted file mode 100644
index 580e2b8..0000000
--- a/examples/camel-example-netty-http/README.txt
+++ /dev/null
@@ -1,55 +0,0 @@
-Camel Netty HTTP Server Example
-===============================
-
-This example shows how to use a shared Netty HTTP Server in an OSGi environment.
-
-There is 3 modules in this example
-
-* shared-netty-http-server - The Shared Netty HTTP server that the other Camel applications uses.
-* myapp-one - A Camel application that reuses the shared Netty HTTP server
-* myapp-two - A Camel application that reuses the shared Netty HTTP server
-
-You will need to compile and prepared this example first:
- mvn install
-
-This example requires running in Apache Karaf / ServiceMix
-
-To install Apache Camel in Karaf you type in the shell (we use version 2.12.0):
-
- features:chooseurl camel 2.12.0
- features:install camel
-
-First you need to install the following features in Karaf/ServiceMix with:
-
- features:install camel-netty-http
-
-Then you can install the shared Netty HTTP server which by default runs on port 8888.
-The port number can be changed by editing the following source file:
-
- shared-netty-http-server/src/main/resources/OSGI-INF/blueprint/http-server.xml
-
-In the Apache Karaf / ServiceMix shell type:
-
- osgi:install -s mvn:org.apache.camel/camel-example-netty-http-shared/2.12.0
-
-Then you can install the Camel applications:
-
- osgi:install -s mvn:org.apache.camel/camel-example-netty-myapp-one/2.12.0
- osgi:install -s mvn:org.apache.camel/camel-example-netty-myapp-two/2.12.0
-
-From a web browser you can then try the example by accessing the followign URLs:
-
- http://localhost:8888/one
- http://localhost:8888/two
-
-This example is documented at
- http://camel.apache.org/netty-http-server-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/3b7abcce/examples/camel-example-osgi-rmi/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-osgi-rmi/README.md b/examples/camel-example-osgi-rmi/README.md
new file mode 100644
index 0000000..7ba2ace
--- /dev/null
+++ b/examples/camel-example-osgi-rmi/README.md
@@ -0,0 +1,51 @@
+# Camel and RMI
+
+### Introduction
+
+This example shows how to work with the Camel-RMI Component.
+
+The example exposes a RMI service over port `37541` running as a Camel application.
+The Camel application must be running.
+
+The Client is standalone and run in a separate JVM. It invokes the RMI service and outputs the reply.
+
+### Build
+
+You will need to compile this example first:
+
+ mvn install
+
+### Run from cmd line outside OSGi container
+
+To start the server
+
+ mvn camel:run
+
+To run the client
+
+ mvn exec:java -PClient
+
+To stop the example hit `ctrl + c`
+
+
+### Run inside OSGi container
+
+If using Apache Karaf / Apache ServiceMix you can install this example
+from the shell
+
+First the camel-rmi feature must be installed
+
+ features:chooseurl camel ${version}
+ features:install camel-rmi
+
+Then install the example
+
+ osgi:install -s mvn:org.apache.camel/camel-example-osgi-rmi/${version}
+
+### Forum, Help, etc
+
+If you hit an 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!
+
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-osgi-rmi/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-osgi-rmi/README.txt b/examples/camel-example-osgi-rmi/README.txt
deleted file mode 100644
index 6290c7f..0000000
--- a/examples/camel-example-osgi-rmi/README.txt
+++ /dev/null
@@ -1,39 +0,0 @@
-Camel and RMI
-=============
-
-This example shows how to work with the Camel-RMI Component.
-
-The example exposes a RMI service over port 37541 running as a Camel application.
-The Camel application must be running.
-
-The Client is standalone and run in a separate JVM. It invokes the RMI service and outputs the reply.
-
-You will need to compile this example first:
- mvn compile
-
-To start the server
- mvn camel:run
-
-To run the client
- mvn exec:java -PClient
-
-To stop the example hit ctrl + c
-
-If using Apache Karaf / Apache ServiceMix you can install this example
-from the shell
-
-First the camel-rmi feature must be installed
- features:chooseurl camel ${version}
- features:install camel-rmi
-
-Then install the example
- osgi:install -s mvn:org.apache.camel/camel-example-osgi-rmi/${version}
-
-If you hit an 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!
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-osgi/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-osgi/README.md b/examples/camel-example-osgi/README.md
new file mode 100644
index 0000000..76113aa
--- /dev/null
+++ b/examples/camel-example-osgi/README.md
@@ -0,0 +1,45 @@
+# OSGi Example
+
+### Introduction
+
+This example shows how use OSGi with Camel. It can be run using Maven.
+
+### Build
+You will need to compile this example first:
+
+ mvn install
+
+### Run from cmd line outside OSGi container
+To run the example using Maven type
+
+ mvn camel:run
+
+To stop the example hit `ctrl + c`
+
+### Run inside OSGi container
+You will need to compile and install this example first:
+
+ mvn install
+
+If using Apache Karaf / Apache ServiceMix you can install this example
+from the shell using this example's "features.xml" for easy provisioning.
+
+ features:addUrl mvn:org.apache.camel/camel-example-osgi/${version}/xml/features
+ features:install camel-example-osgi
+
+The example outputs to the log, which you can see using
+
+ log:display
+
+... or you can tail the log with
+
+ log:tail
+
+And use `ctrl+c` to break the tail.
+
+### Forum, Help, etc
+
+If you hit an 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!
http://git-wip-us.apache.org/repos/asf/camel/blob/3b7abcce/examples/camel-example-osgi/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-osgi/README.txt b/examples/camel-example-osgi/README.txt
deleted file mode 100644
index d3071e1..0000000
--- a/examples/camel-example-osgi/README.txt
+++ /dev/null
@@ -1,46 +0,0 @@
-OSGi Example
-=====================
-
-This example shows how use OSGi with Camel. It can be run using Maven.
-
-Running from cmd line outside OSGi container
-============================================
-
-You will need to compile this example first:
- mvn compile
-
-To run the example using Maven type
- mvn camel:run
-
-To stop the example hit ctrl + c
-
-Running inside OSGi container
-=============================
-
-You will need to compile and install this example first:
- mvn install
-
-If using Apache Karaf / Apache ServiceMix you can install this example
-from the shell using this example's "features.xml" for easy provisioning.
-
- features:addUrl mvn:org.apache.camel/camel-example-osgi/${version}/xml/features
- features:install camel-example-osgi
-
-The example outputs to the log, which you can see using
-
- log:display
-
-... or you can tail the log with
-
- log:tail
-
-And use ctrl+c to break the tail.
-
-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!