Skip to content

Commit 9315d11

Browse files
committed
Update README.md
Add notice of Python 3.6+ requirement. Change block quote styling from bash to console to reflect nature of what is being quoted.
1 parent b1a50f0 commit 9315d11

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,22 @@ records for STARTTLS support. It saves its results to CSV or JSON.
1212

1313
## Getting Started ##
1414

15+
`trustymail` requires **Python 3.6+**. Python 2 is not supported.
16+
1517
`trustymail` can be installed as a module or run directly from the
1618
repository.
1719

1820
### Installed as a module ###
1921

2022
`trustymail` can be installed directly via pip:
2123

22-
```bash
24+
```console
2325
pip install trustymail
2426
```
2527

2628
It can then be run directly:
2729

28-
```bash
30+
```console
2931
trustymail [options] example.com
3032
```
3133

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

37-
```bash
39+
```console
3840
pip install -r requirements.txt
3941
```
4042

4143
Then run the CLI:
4244

43-
```bash
45+
```console
4446
python scripts/trustymail [options] example.com
4547
```
4648

4749
### Using Docker (optional)
4850

49-
```bash
51+
```console
5052
./run [opts]
5153
```
5254

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

5557
### Usage and examples ###
5658

57-
```bash
59+
```console
5860
trustymail [options] INPUT
5961

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

6870
#### Options ####
6971

70-
```bash
72+
```console
7173
-h --help Show this message.
7274
-o --output=OUTFILE Name of output file. (Default results)
7375
-t --timeout=TIMEOUT The DNS lookup timeout in seconds. (Default is 5.)

0 commit comments

Comments
 (0)