Skip to content

Commit

Permalink
Clarify
Browse files Browse the repository at this point in the history
  • Loading branch information
davepeck committed Mar 25, 2024
1 parent 0a8ed00 commit 8714273
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ This is useful in development, often as part of a `docker-compose.yml`.

There have been a couple cases recently where I wanted to work with an OSS tool that required a configured SMTP server (for instance, to send password reset or login link emails). The tool itself didn't offer an alternative, so creating a simple logging SMTP service seemed like the best way to go.

## Installation via docker
## Installation and usage via Docker

This is probably how you want to use `smtp-logger`. This way your project does not need to depend on python (even though the docker image does).

The latest version of `smtp-logger` is packaged in a docker image available at `https://ghcr.io/literalgarage/smtp-logger:latest`.

Expand All @@ -30,16 +32,14 @@ smtp:
- "8025:8025"
```

## Installation locally
## Installation and usage locally

Install this library using `pip`:

```bash
pip install smtp-logger
```

## Usage

This provides an `smtp-logger` binary:

```
Expand Down

0 comments on commit 8714273

Please sign in to comment.