Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Converted the README to markdown.

Change-Id: I8f498fd54a1f2dc8b39e06738215e7758f12c8d7
Reviewed-on: http://review.membase.org/4966
Reviewed-by: Michael Wiederhold <mike@membase.com>
Tested-by: Dustin Sallings <dustin@spy.net>
  • Loading branch information...
commit 8d70c1b56d4ce1c53c6a24d0a1c273b81c6100dc 1 parent 4a70085
@dustin dustin authored
Showing with 56 additions and 52 deletions.
  1. +0 −52 README
  2. +56 −0 README.markdown
View
52 README
@@ -1,52 +0,0 @@
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- __ __
- |__|/ |______ ______
- | \ __\__ \ \____ \
- | || | / __ \| |_> >
- /\__| ||__| (____ / __/
- \______| \/|__|
-
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- A Tap Client for Java
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Building:
-
- ant build
-
- A jar should be generated in the build folder
-
-Documentation:
-
- ant docs
-
- Check out docs/javadocs/index.html
-
-Using:
-
- You need to create a TapStreamClient, an Exporter, and a TapStream. The
- TapStreamClient is given an exporter which handles data output from the tap stream
- connection. To start streaming data call the start function in TapStreamClient and
- pass in a TapStream template.
-
-Example:
-
- Creates a custom tap stream that will dump all key in a Membase server and send only
- the key names. All of the key names will be exported to a file named "results.txt"
-
- TapStreamClient client = new TapStreamClient("10.1.5.102", 11210, "default", null);
- Exporter exporter = new FileExporter("results.txt");
- CustomStream tapListener = new CustomStream(exporter, "node1");
- tapListener.keysOnly();
- tapListener.doDump();
- client.start(tapListener);
-
-Contact:
-
- For help with the java tap client post questions to the couchbase forum:
- http://techzone.couchbase.com/forums/couchbase/couchbase-server
-
-
- The full specification for the TAP protocol can be found here:
- http://techzone.couchbase.com/wiki/display/membase/TAP+Protocol
View
56 README.markdown
@@ -0,0 +1,56 @@
+----------------------------------------------------------------------
+ __ __
+ |__|/ |______ ______
+ | \ __\__ \ \____ \
+ | || | / __ \| |_> >
+ /\__| ||__| (____ / __/
+ \______| \/|__|
+
+----------------------------------------------------------------------
+ A Tap Client for Java
+----------------------------------------------------------------------
+
+
+# Building
+
+ ant build
+
+A jar should be generated in the build folder
+
+# Documentation
+
+ ant docs
+
+Check out docs/javadocs/index.html
+
+# Using
+
+You need to create a `TapStreamClient`, an `Exporter`, and a
+`TapStream`. The `TapStreamClient` is given an exporter which handles
+data output from the tap stream connection. To start streaming data
+call the start function in `TapStreamClient` and pass in a `TapStream`
+template.
+
+# Example
+
+Creates a custom tap stream that will dump all key in a Membase server
+and send only the key names. All of the key names will be exported to
+a file named `results.txt`
+
+ TapStreamClient client = new TapStreamClient("10.1.5.102", 11210, "default", null);
+ Exporter exporter = new FileExporter("results.txt");
+ CustomStream tapListener = new CustomStream(exporter, "node1");
+ tapListener.keysOnly();
+ tapListener.doDump();
+ client.start(tapListener);
+
+# Contact
+
+The [couchbase server forums][forum] welcomes you and whatever
+questions you may have regarding using jtap and all other things
+couchbase.
+
+See also: the full specification for the [TAP protocol][tapspec].
+
+[tapspec]: http://techzone.couchbase.com/wiki/display/membase/TAP+Protocol
+[forum]: http://techzone.couchbase.com/forums/couchbase/couchbase-server
Please sign in to comment.
Something went wrong with that request. Please try again.