summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlan Lacerda <alacerda@alpinelinux.org>2015-04-28 17:24:44 +0000
committerAlan Lacerda <alacerda@alpinelinux.org>2015-04-28 17:24:44 +0000
commit818853b058dd5b48af7cefcff5871944eeac07b8 (patch)
tree7841c4ae71446dd2618224e8574bc61cefbae158
parentf1ede5d7472172edde3567f636f611840206b6e8 (diff)
downloadsetup-box-818853b058dd5b48af7cefcff5871944eeac07b8.tar.bz2
setup-box-818853b058dd5b48af7cefcff5871944eeac07b8.tar.xz
README: formating
-rw-r--r--README33
1 files 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