[travis] convert README to markdown format so build image can be disp…

…layed
adally · Mar 16, 2014 · c8660b7 · c8660b7
1 parent cadbc3d
commit c8660b7
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 33 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,38 @@
+Yahoo! Cloud System Benchmark (YCSB)
+====================================
+[![Build Status](https://travis-ci.org/brianfrankcooper/YCSB.png?branch=master)](https://travis-ci.org/brianfrankcooper/YCSB)
+
+Links
+-----
+http://wiki.github.com/brianfrankcooper/YCSB/  
+http://research.yahoo.com/Web_Information_Management/YCSB/  
+[email protected]  
+
+Getting Started
+---------------
+
+1. Download the latest release of YCSB:
+
+    ```sh
+    wget https://github.com/downloads/brianfrankcooper/YCSB/ycsb-0.1.4.tar.gz
+    tar xfvz ycsb-0.1.4
+    cd ycsb-0.1.4
+    ```
+
+2. Set up a database to benchmark. There is a README file under each binding 
+   directory.
+
+3. Run YCSB command. 
+
+    ```sh
+    bin/ycsb load basic -P workloads/workloada
+    bin/ycsb run basic -P workloads/workloada
+    ```
+
+  Running the `ycsb` command without any argument will print the usage. 
+
+  See https://github.com/brianfrankcooper/YCSB/wiki/Running-a-Workload
+  for a detailed documentation on how to run a workload.
+
+  See https://github.com/brianfrankcooper/YCSB/wiki/Core-Properties for 
+  the list of available workload properties.