Permalink
Browse files

added license, additional details for such

  • Loading branch information...
1 parent 769372c commit 4897d69195f5541665a712ebbc71f445b210bd42 zznate committed Sep 29, 2010
Showing with 38 additions and 0 deletions.
  1. +21 −0 LICENSE
  2. +17 −0 README.mdown
View
21 LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Nate McCall (a.k.a zznate)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
@@ -1,3 +1,5 @@
+Overview
+---------
cassandra-stress is modeled after the stress.py script in Apache Cassandra's source distribution.
cassandra-stress is built on top of [Hector](http://github.com/rantav/hector), a well-tested and widely deployed Java client for Apache Cassandra. The benefits of using Hector for a tool like this are many:
@@ -18,5 +20,20 @@ cassandra-stress is a currently just a command line app which supports the follo
-t,--threads <arg> The number of client threads to create
-h,--help Print this help message and exit
+Running cassandra-stress is currently easiest via the mvn-exec-plugin. An example invocation is below:
+`mvn -e exec:java -Dexec.mainClass="com.riptano.cassandra.stress.Stress" -Dexec.args="-o multiget -b 50 -n 12000"`
+Todo (in rough priority)
+------------------------
++ Roll Jar for non-maven required execution
++ Create ColumnFamily specifically for test
++ Added standard deviation option for gaussian key distribution
++ SuperColumn support
++ Apache Cassandra 0.6.x support
+Misc.
+------
+Offered under an MIT license (see LICENSE in the top level directory). As with any halfway decent load testing tool, you can generate a lot of load and put a system under duress or even cause it to fail. You are solely responsible for any issues experienced the execution of this tool may cause. Use at your own risk.
+
+Cheers,
+zznate

0 comments on commit 4897d69

Please sign in to comment.