[17/17] camel git commit: CAMEL-10721: connectors docs

[da...@apache.org]

CAMEL-10721: connectors docs


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/88a76451
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/88a76451
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/88a76451

Branch: refs/heads/master
Commit: 88a7645191b77dc86f908e604763d1d1af016bfb
Parents: f79d981
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Jan 19 09:58:12 2017 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Jan 19 11:00:00 2017 +0100

----------------------------------------------------------------------
 connectors/examples/bar-connector/Readme.md     |  6 ++++++
 .../examples/beverage-component/Readme.md       |  5 +++++
 .../examples/foo-bar-wine-example/Readme.md     | 22 ++++++++++++++++++++
 connectors/examples/foo-connector/Readme.md     |  5 +++++
 connectors/examples/wine-connector/Readme.md    |  6 ++++++
 5 files changed, 44 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/88a76451/connectors/examples/bar-connector/Readme.md
----------------------------------------------------------------------
diff --git a/connectors/examples/bar-connector/Readme.md b/connectors/examples/bar-connector/Readme.md
new file mode 100644
index 0000000..5dae132
--- /dev/null
+++ b/connectors/examples/bar-connector/Readme.md
@@ -0,0 +1,6 @@
+## Bar Connector
+
+A Camel connector that is based on the `beverage-component`.
+
+This connector is a very basic connector with only a few options.
+

http://git-wip-us.apache.org/repos/asf/camel/blob/88a76451/connectors/examples/beverage-component/Readme.md
----------------------------------------------------------------------
diff --git a/connectors/examples/beverage-component/Readme.md b/connectors/examples/beverage-component/Readme.md
new file mode 100644
index 0000000..934a3a1
--- /dev/null
+++ b/connectors/examples/beverage-component/Readme.md
@@ -0,0 +1,5 @@
+## Beverage Component
+
+A 3rd party Camel component to be used as base for the `bar` and `wine` Camel connectors. 
+
+This is used to demonstrate that Camel connectors also work with 3rd party components.

http://git-wip-us.apache.org/repos/asf/camel/blob/88a76451/connectors/examples/foo-bar-wine-example/Readme.md
----------------------------------------------------------------------
diff --git a/connectors/examples/foo-bar-wine-example/Readme.md b/connectors/examples/foo-bar-wine-example/Readme.md
new file mode 100644
index 0000000..e65dfc2
--- /dev/null
+++ b/connectors/examples/foo-bar-wine-example/Readme.md
@@ -0,0 +1,22 @@
+## Foo Bar and Wine Example
+
+This is an example that uses the `foo`, `bar` and `wine` Camel connectors. These connectors
+are used as if they are regular Camel components in Camel routes.
+
+See the `FooBarWineRoute` class for more details.
+
+### How to run
+
+This example can be run from the command line using:
+
+    mvn camel:run
+    
+### Apache Camel IDEA Plugin
+    
+You can use tooling such as the Apache Camel IDEA Plugin to offer code assistance while create the Camel route.
+
+The tooling offers code completions such as listing the possible options you can use with the Camel connectors.
+Notice how the tool presents only the pre-selected options of these connectors. For example the `foo` connector
+which is based on the Camel `Timer` component only offers two options, where as if you are using `timer` instead
+you will have many more options.
+

http://git-wip-us.apache.org/repos/asf/camel/blob/88a76451/connectors/examples/foo-connector/Readme.md
----------------------------------------------------------------------
diff --git a/connectors/examples/foo-connector/Readme.md b/connectors/examples/foo-connector/Readme.md
new file mode 100644
index 0000000..c9c4487
--- /dev/null
+++ b/connectors/examples/foo-connector/Readme.md
@@ -0,0 +1,5 @@
+## Foo Connector
+
+This is a basic Camel connector that is based on the Timer component from Apache Camel.
+
+This connector is a very basic connector with only a few options.

http://git-wip-us.apache.org/repos/asf/camel/blob/88a76451/connectors/examples/wine-connector/Readme.md
----------------------------------------------------------------------
diff --git a/connectors/examples/wine-connector/Readme.md b/connectors/examples/wine-connector/Readme.md
new file mode 100644
index 0000000..790e4b0
--- /dev/null
+++ b/connectors/examples/wine-connector/Readme.md
@@ -0,0 +1,6 @@
+## Wine Connector
+
+A Camel connector that is based on the `beverage-component`.
+
+This connector is a very basic connector with only a few options.
+