Skip to content

Commit

Permalink
added install tldr.
Browse files Browse the repository at this point in the history
  • Loading branch information
bellma101 committed Mar 11, 2019
1 parent 016a6fd commit 77a5dad
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ A variety of wordlists are used, both for subdomain bruteforcing and content dis
### Installation
Clone this repo and run the included `installer.sh` script, optionally including a custom file path to install necessary tools to. Make sure to run `source ~/.profile` in your terminal after running the installer in order to add the Go binary path to your $PATH variable. Then run Chomp Scan. If you are using zsh, fish, or some other shell, make sure that `~/go/bin` is in your path. For more details, see the [Installation](https://github.com/SolomonSklash/chomp-scan/wiki/Installation) wiki page.

TLDR: `root@kali:~/chomp-scan# ./installer.sh [/some/optional/install/path]`

### Usage
Chomp Scan always runs subdomain enumeration, thus a domain is required via the `-u` flag. The domain should not contain a scheme, e.g. http:// or https://. By default, HTTPS is always used. This can be changed to HTTP by passing the `-H` flag. A wordlist is optional, and if one is not provided the built-in short list (20k words) is used.

Expand Down

0 comments on commit 77a5dad

Please sign in to comment.