Skip to content

Commit

Permalink
Merge branch 'master' into tor
Browse files Browse the repository at this point in the history
  • Loading branch information
mpieters93 committed Dec 29, 2018
2 parents 6cd18fb + ff2f26e commit 51ce9fc
Show file tree
Hide file tree
Showing 4 changed files with 221 additions and 40 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Jupyter Notebook
.ipynb_checkpoints
*.ipynb

# Output files, except requirements.txt
*.txt
!requirements.txt

# Comma-Separated Values (CSV) Reports
*.csv
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

## Installation

**NOTE**: Python 3.6 or higher is required.

```bash
# clone the repo
$ git clone https://github.com/sdushantha/sherlock.git
Expand All @@ -23,7 +25,7 @@ $ pip3 install -r requirements.txt

```bash
$ python3 sherlock.py --help
usage: sherlock.py [-h] [--version] [--verbose] [--quiet] [--tor] [--unique-tor]
usage: sherlock.py [-h] [--version] [--verbose] [--quiet] [--csv] [--tor] [--unique-tor]
USERNAMES [USERNAMES ...]

Sherlock: Find Usernames Across Social Networks (Version 0.1.0)
Expand All @@ -37,6 +39,7 @@ optional arguments:
--verbose, -v, -d, --debug
Display extra debugging information.
--quiet, -q Disable debugging information (Default Option).
--csv Create Comma-Separated Values (CSV) File.
--tor, -t Make requests over TOR; increases runtime; requires TOR to be installed and in system path.
--unique-tor, -u Make requests over TOR with new TOR circuit after each request; increases runtime; requires TOR to be installed and in system path.
```
Expand Down
Loading

0 comments on commit 51ce9fc

Please sign in to comment.