svn commit: r1302329 - in /camel/trunk/examples/camel-example-twitter-websocket: ./ README.txt

[da...@apache.org]

Author: davsclaus
Date: Mon Mar 19 08:58:23 2012
New Revision: 1302329

URL: http://svn.apache.org/viewvc?rev=1302329&view=rev
Log:
Added README.txt to example.

Added:
    camel/trunk/examples/camel-example-twitter-websocket/README.txt   (with props)
Modified:
    camel/trunk/examples/camel-example-twitter-websocket/   (props changed)

Propchange: camel/trunk/examples/camel-example-twitter-websocket/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Mon Mar 19 08:58:23 2012
@@ -0,0 +1,17 @@
+.pmd
+.checkstyle
+.ruleset
+target
+.settings
+.classpath
+.project
+.wtpmodules
+prj.el
+.jdee_classpath
+.jdee_sources
+velocity.log
+eclipse-classes
+*.ipr
+*.iml
+*.iws
+*.idea

Added: camel/trunk/examples/camel-example-twitter-websocket/README.txt
URL: http://svn.apache.org/viewvc/camel/trunk/examples/camel-example-twitter-websocket/README.txt?rev=1302329&view=auto
==============================================================================
--- camel/trunk/examples/camel-example-twitter-websocket/README.txt (added)
+++ camel/trunk/examples/camel-example-twitter-websocket/README.txt Mon Mar 19 08:58:23 2012
@@ -0,0 +1,44 @@
+Twitter and Websocket Example
+=============================
+
+The example is demonstrating how to poll a constant feed of twitter searches
+and publish results in real time using web socket to a web page.
+
+To use twitter, you need a twitter account which have setup an application to be used.
+For twitter users, you may be familiar that twitter requires you to grant applications
+access to your twitter account, such as twitter for iphone etc.
+The same applies for this example.
+
+We have described this in more details at the Camel twitter documentation:
+  http://camel.apache.org/twitter
+
+When you have created an application, you get a number of details back from twitter
+which you need to use the twitter component. Enter these details in the source code at:
+  src/main/java/org/apache/camel/example/websocket/CamelTwitterWebSocketMain.java
+in the constant fields, by replacing the values "INSERT HERE".
+
+You will need to compile this example first:
+  mvn compile
+
+To run the example type
+  mvn exec:java
+
+Then open a browser to see live twitter updates in the web page
+  http://localhost:9090
+
+To stop the example hit ctrl + c
+
+This example is documented at
+  http://camel.apache.org/twitter-websocket-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!
+
+
+

Propchange: camel/trunk/examples/camel-example-twitter-websocket/README.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: camel/trunk/examples/camel-example-twitter-websocket/README.txt
------------------------------------------------------------------------------
    svn:mime-type = text/plain