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:45:56 UTC
[12/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/eea1c44d
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/eea1c44d
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/eea1c44d
Branch: refs/heads/master
Commit: eea1c44d001850389c23ecb530fe30733932a434
Parents: f9f54c1
Author: gautric <ga...@redhat.com>
Authored: Wed Dec 9 19:51:54 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Dec 10 07:45:00 2015 +0100
----------------------------------------------------------------------
examples/README.md | 25 ++++++++++++
examples/README.txt | 26 -------------
examples/camel-example-gae/README.md | 3 +-
examples/camel-example-gauth/README.md | 14 +++++++
examples/camel-example-gauth/README.txt | 13 -------
examples/camel-example-guice-jms/README.md | 48 ++++++++++++++++++++++++
examples/camel-example-guice-jms/README.txt | 41 --------------------
examples/camel-example-jdbc/README.md | 46 +++++++++++++++++++++++
examples/camel-example-jdbc/README.txt | 43 ---------------------
examples/camel-example-jms-file/README.md | 36 ++++++++++++++++++
examples/camel-example-jms-file/README.txt | 28 --------------
11 files changed, 170 insertions(+), 153 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/eea1c44d/examples/README.md
----------------------------------------------------------------------
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 0000000..35a87ac
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,25 @@
+# Welcome to the Apache Camel Examples!
+
+### Introduction
+
+This directory contains the various examples for working with Apache
+Camel. The examples can be run using Maven. When using the Maven
+command, Maven will attempt to download the required dependencies from a
+central repository to your local repository.
+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)
+
+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/)
+
+### 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/eea1c44d/examples/README.txt
----------------------------------------------------------------------
diff --git a/examples/README.txt b/examples/README.txt
deleted file mode 100644
index 2f5677a..0000000
--- a/examples/README.txt
+++ /dev/null
@@ -1,26 +0,0 @@
-Welcome to the Apache Camel Examples!
-=====================================
-
-This directory contains the various examples for working with Apache
-Camel. The examples can be run using Maven. When using the Maven
-command, Maven will attempt to download the required dependencies from a
-central repository to your local repository.
-View the individual example READMEs for details.
-
-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/
-
-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/eea1c44d/examples/camel-example-gae/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-gae/README.md b/examples/camel-example-gae/README.md
index df53e02..51fe494 100644
--- a/examples/camel-example-gae/README.md
+++ b/examples/camel-example-gae/README.md
@@ -2,8 +2,7 @@
### Introduction
-Building, deplyoing and running this example is described in detail at
-[http://camel.apache.org/tutorial-for-camel-on-google-app-engine.html](http://camel.apache.org/tutorial-for-camel-on-google-app-engine.html)
+Building, deplyoing and running this example is described in detail at [http://camel.apache.org/tutorial-for-camel-on-google-app-engine.html](http://camel.apache.org/tutorial-for-camel-on-google-app-engine.html)
### Forum, Help, etc
http://git-wip-us.apache.org/repos/asf/camel/blob/eea1c44d/examples/camel-example-gauth/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-gauth/README.md b/examples/camel-example-gauth/README.md
new file mode 100644
index 0000000..9aef762
--- /dev/null
+++ b/examples/camel-example-gauth/README.md
@@ -0,0 +1,14 @@
+# GAuth Example
+
+### Introduction
+Building, deploying and running this example is described in detail at [http://camel.apache.org/tutorial-oauth.html](http://camel.apache.org/tutorial-oauth.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/eea1c44d/examples/camel-example-gauth/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-gauth/README.txt b/examples/camel-example-gauth/README.txt
deleted file mode 100644
index 7d25b5b..0000000
--- a/examples/camel-example-gauth/README.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-GAuth Example
-=============
-
-Building, deploying and running this example is described in detail at
-http://camel.apache.org/tutorial-oauth.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/eea1c44d/examples/camel-example-guice-jms/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-guice-jms/README.md b/examples/camel-example-guice-jms/README.md
new file mode 100644
index 0000000..860211c
--- /dev/null
+++ b/examples/camel-example-guice-jms/README.md
@@ -0,0 +1,48 @@
+# Guice Example
+
+### Introduction
+
+This example shows how to work with files and JMS, using Guice to boot up
+Camel and configure the routes.
+
+The example consumes messages from a queue and writes them to the file
+system.
+
+### Build
+
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+
+To run the example type:
+
+ mvn exec:java
+
+Alternatively to run the example you can also make use of the Guice Maven
+Plugin provided by Camel, so you can instead type:
+
+ mvn guice:run
+
+See the POM of this example about how to make use of this Maven Plugin
+
+You can see the routing rules by looking at the java code in the
+`src/main/java directory` and the `guicejndi.properties` file lives in
+`src/main/resources/guicejndi.properties`
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+
+This example is documented at [http://camel.apache.org/guice-jms-example.html](http://camel.apache.org/guice-jms-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/eea1c44d/examples/camel-example-guice-jms/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-guice-jms/README.txt b/examples/camel-example-guice-jms/README.txt
deleted file mode 100644
index 1c71ba8..0000000
--- a/examples/camel-example-guice-jms/README.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-Guice Example
-=============
-
-This example shows how to work with files and JMS, using Guice to boot up
-Camel and configure the routes.
-
-The example consumes messages from a queue and writes them to the file
-system.
-
-You will need to compile this example first:
-
- mvn compile
-
-To run the example type:
-
- mvn exec:java
-
-Alternatively to run the example you can also make use of the Guice Maven
-Plugin provided by Camel, so you can instead type:
-
- mvn guice:run
-
-See the POM of this example about how to make use of this Maven Plugin
-
-You can see the routing rules by looking at the java code in the
-src/main/java directory and the guicejndi.properties file lives in
-src/main/resources/guicejndi.properties
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/guice-jms-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/eea1c44d/examples/camel-example-jdbc/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-jdbc/README.md b/examples/camel-example-jdbc/README.md
new file mode 100644
index 0000000..72e8bbb
--- /dev/null
+++ b/examples/camel-example-jdbc/README.md
@@ -0,0 +1,46 @@
+# Camel JDBC Example
+
+### Introduction
+
+This example shows how to use camel-jdbc component with an embedded
+Apache Derby database.
+
+### Build
+
+First compile this example:
+
+ mvn compile
+
+### Compile
+
+Now to run the example type
+
+ mvn camel:run
+
+To stop the example hit `ctrl + c`
+
+### Configuration
+
+This example uses Spring to setup and configure the database,
+as well the CamelContext.
+
+You can see this in the following file:
+* `src/main/resources/META-INF/spring/camel-context.xml`
+
+The spring config setups three routes as follow:
+
+* `sample-generator-route`
+ - This route will generate sample data into database upon Camel starts.
+* `query-update-route-part1/query-update-route-part2`
+ - These two are connected together. It first query the database for NEW record to be process, invoke RecordProcess bean to do the work, then update the record as DONE so not to re-process on next polled.
+
+
+### 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/eea1c44d/examples/camel-example-jdbc/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-jdbc/README.txt b/examples/camel-example-jdbc/README.txt
deleted file mode 100644
index 8ddab78..0000000
--- a/examples/camel-example-jdbc/README.txt
+++ /dev/null
@@ -1,43 +0,0 @@
-Camel JDBC Example
-==================
-
-This example shows how to use camel-jdbc component with an embedded
-Apache Derby database.
-
-This example uses Spring to setup and configure the database,
-as well the CamelContext.
-
-You can see this in the following file:
- - src/main/resources/META-INF/spring/camel-context.xml
-
-The spring config setups three routes as follow:
-
- sample-generator-route
- This route will generate sample data into database upon Camel starts.
-
- query-update-route-part1/query-update-route-part2
- These two are connected together. It first query the database for
- NEW record to be process, invoke RecordProcess bean to do the work,
- then update the record as DONE so not to re-process on next polled.
-
-Standalone
-----------
-First compile this example:
- mvn compile
-
-Now to run the example type
- mvn camel:run
-
-To stop the example hit ctrl + c
-
-Help
-----
-
-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/eea1c44d/examples/camel-example-jms-file/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-jms-file/README.md b/examples/camel-example-jms-file/README.md
new file mode 100644
index 0000000..cbceb58
--- /dev/null
+++ b/examples/camel-example-jms-file/README.md
@@ -0,0 +1,36 @@
+# JMS & File Example
+
+### Introduction
+This example shows how to work with files and JMS.
+
+The example consumes messages from a queue and writes them to the file
+system.
+
+### Build
+
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+
+The example should run if you type
+
+ mvn exec:java -PExample
+
+After the example is complete, then there should be 10 files written
+in the test directory.
+
+### Documentation
+
+This example is documented at [http://camel.apache.org/walk-through-an-example.html](http://camel.apache.org/walk-through-an-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/eea1c44d/examples/camel-example-jms-file/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-jms-file/README.txt b/examples/camel-example-jms-file/README.txt
deleted file mode 100644
index 9ee604b..0000000
--- a/examples/camel-example-jms-file/README.txt
+++ /dev/null
@@ -1,28 +0,0 @@
-JMS & File Example
-==================
-
-This example shows how to work with files and JMS.
-
-The example consumes messages from a queue and writes them to the file
-system.
-
-You will need to compile this example first:
- mvn compile
-
-The example should run if you type
- mvn exec:java -PExample
-
-After the example is complete, then there should be 10 files written
-in the test directory.
-
-This example is documented at
- http://camel.apache.org/walk-through-an-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!