Skip to content

Commit

Permalink
Merge pull request #118 from cisagov/update_readme_add_python3_requir…
Browse files Browse the repository at this point in the history
…ement

Update README.md
  • Loading branch information
mcdonnnj committed Aug 19, 2019
2 parents b1a50f0 + 9315d11 commit 830cc7a
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Expand Up @@ -12,20 +12,22 @@ records for STARTTLS support. It saves its results to CSV or JSON.

## Getting Started ##

`trustymail` requires **Python 3.6+**. Python 2 is not supported.

`trustymail` can be installed as a module or run directly from the
repository.

### Installed as a module ###

`trustymail` can be installed directly via pip:

```bash
```console
pip install trustymail
```

It can then be run directly:

```bash
```console
trustymail [options] example.com
```

Expand All @@ -34,27 +36,27 @@ trustymail [options] example.com
To run the tool locally from the repository, without installing, first
install the requirements:

```bash
```console
pip install -r requirements.txt
```

Then run the CLI:

```bash
```console
python scripts/trustymail [options] example.com
```

### Using Docker (optional)

```bash
```console
./run [opts]
```

`opts` are the same arguments that would get passed to `trustymail`.

### Usage and examples ###

```bash
```console
trustymail [options] INPUT

trustymail dhs.gov
Expand All @@ -67,7 +69,7 @@ output will always be written to disk, defaulting to `results.csv`.

#### Options ####

```bash
```console
-h --help Show this message.
-o --output=OUTFILE Name of output file. (Default results)
-t --timeout=TIMEOUT The DNS lookup timeout in seconds. (Default is 5.)
Expand Down

0 comments on commit 830cc7a

Please sign in to comment.