From 818853b058dd5b48af7cefcff5871944eeac07b8 Mon Sep 17 00:00:00 2001 From: Alan Lacerda Date: Tue, 28 Apr 2015 17:24:44 +0000 Subject: README: formating --- README | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/README b/README index a0b9a79..642d347 100644 --- a/README +++ b/README @@ -1,20 +1,31 @@ -REQUIRED: - jq - A command-line JSON processor - -BASIC USAGE: -Installing a full pentest box: +setup-box +========= - ~# setup-box -g pentest +setup-box is a tool to make easier the task of setting up an Alpine Linux box. +You can even use the pre-set environment or define your own by creating the proper +json file. -Installing VoIP pentest tools: - ~# setup-box pentest.voip +Depends on +---------- + jq - A command-line JSON processor -Installing VoIP and Forensics tools + +Examples +-------- +* Installing a full pentest box (without a desktop environment): + ~# setup-box -g pentest - ~# setup-box pentest.voip pentest.forensics +* Installing only VoIP pentest tools: + ~# setup-box pentest.voip +* Installing VoIP and Forensics tools: + ~# setup-box -e pentest.voip -e pentest.forensics +or + ~# setup-box -e "pentest.voip pentest.forensics" -Checking groups and avaliable tools: +* Installing VoIP tools and XFCE desktop: + ~# setup-box -e pentest.voip -d xfce +* Checking groups and avaliable tools: ~/setup-box# cat json/pentest.json -- cgit v1.2.3