From e42921dec2ecbb3b5c65e3041eded3de8eff59e0 Mon Sep 17 00:00:00 2001 From: Patrick Tulskie Date: Sat, 4 Feb 2023 18:02:39 -0500 Subject: [PATCH] Updating the readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6e413c8..fad1f31 100644 --- a/README.md +++ b/README.md @@ -44,10 +44,10 @@ While concuss is designed to be used as a command line tool, you can also includ require 'concuss' concuss = Concuss.new(url: 'http://localhost:4567', file: 'header_file.txt', header_set: :standard, test_string: "OOGABOOGA") -concuss.attack! +report = concuss.attack! ``` -This will spit out the results, which isn't super useful if you need to post process them... I'll work on that though. +From there, you'll get a `Concuss::Report` object that contains the raw data as well as filters for `hits`, `misses`, `headers`, and the `url` in the event you've done a bunch of these. ## Demo