From a7f2110c69f27d3d7f46b817e34d20d0f000abb8 Mon Sep 17 00:00:00 2001 From: Brett Langdon Date: Sun, 21 Oct 2012 10:11:11 -0700 Subject: [PATCH] Update Readme.md --- Readme.md | 45 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index ff551f7..0adf422 100644 --- a/Readme.md +++ b/Readme.md @@ -1,7 +1,48 @@ - # tommygun - HTTP Benchmarking Tool +HTTP Benchmarking Tool written in Node.JS. + +## Configuration + +Tommygun uses ini files to specify what urls and settings to test. Each section corresponds to the url to test and +each property corresponds to specific settings for that given url. If the property occurs outside of a section then +tommygun those settings are used by tommygun. + +### Example +```ini +;this setting is used by tommygun globally +random = false + +[localhost] +port = 8000 +num = 5 + +[localhost/submit] +port = 8000 +data = this is a test +method = post +num = 2 + +[www.google.com] + +[www.github.com] +``` + +## Usage + +### Get Help +```bash +tommygun --help +``` + +### Simple Usage +```bash +tommygun config.ini +``` + +## Name + +The name for tommygun came from a play off of the name for http://www.github.com/newsapps/beeswithmachineguns ## License