Skip to content

Commit 3b688fc

Browse files
committed
Update installation instructions in the README
Since the `scripts/trustymail` file is now integrated directly into the Python package the installation and usage directions in the README must be updated.
1 parent 201c5f6 commit 3b688fc

File tree

1 file changed

+3
-15
lines changed

1 file changed

+3
-15
lines changed

README.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,7 @@ records for STARTTLS support. It saves its results to CSV or JSON.
1414

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

17-
`trustymail` can be installed as a module or run directly from the
18-
repository.
19-
20-
### Installed as a module ###
17+
### Local installation ###
2118

2219
`trustymail` can be installed directly via pip:
2320

@@ -31,19 +28,10 @@ It can then be run directly:
3128
trustymail [options] example.com
3229
```
3330

34-
### Running directly ###
35-
36-
To run the tool locally from the repository, without installing, first
37-
install the requirements:
38-
39-
```console
40-
pip install -r requirements.txt
41-
```
42-
43-
Then run the CLI:
31+
or
4432

4533
```console
46-
python scripts/trustymail [options] example.com
34+
python3 -m trustymail [options] example.com
4735
```
4836

4937
### Using Docker (optional) ###

0 commit comments

Comments
 (0)