Skip to content

Commit c613b99

Browse files
committed
docs: update usage examples
1 parent 08f9955 commit c613b99

1 file changed

Lines changed: 5 additions & 21 deletions

File tree

README.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,44 +10,28 @@ Multi-platform Docker container with utilities to process Mailbox files and Mail
1010
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/10081/badge)](https://bestpractices.coreinfrastructure.org/projects/10081)
1111
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/leplusorg/docker-mail/badge)](https://securityscorecards.dev/viewer/?uri=github.com/leplusorg/docker-mail)
1212

13-
## Example without using the filesystem
13+
## Example
1414

15-
Let's say that you want to convert an Mailbox file intput.mail in your current working directory to HTML:
15+
Let's say that you want to know the number of messages in a Maildir folder in your current working directory:
1616

1717
**Mac/Linux**
1818

1919
```bash
20-
cat intput.mail | docker run --rm -i --net=none leplusorg/mail asciidoc -o - > output.html
21-
```
22-
23-
**Windows**
24-
25-
```batch
26-
type intput.mail | docker run --rm -i --net=none leplusorg/mail asciidoc -o - > output.html
27-
```
28-
29-
## Example using the filesystem
30-
31-
Same thing, assuming that you want to convert an Mailbox file intput.mail in your current working directory to HTML:
32-
33-
**Mac/Linux**
34-
35-
```bash
36-
docker run --rm -t --user="$(id -u):$(id -g)" --net=none -v "$(pwd):/tmp" leplusorg/mail asciidoc -o output.html intput.mail
20+
docker run --rm -t --user="$(id -u):$(id -g)" --net=none -v "$(pwd):/tmp" leplusorg/mail messages maildir
3721
```
3822

3923
**Windows**
4024

4125
In `cmd`:
4226

4327
```batch
44-
docker run --rm -t --net=none -v "%cd%:/tmp" leplusorg/mail asciidoc -o output.html intput.mail
28+
docker run --rm -t --net=none -v "%cd%:/tmp" leplusorg/mail messages maildir
4529
```
4630

4731
In PowerShell:
4832

4933
```pwsh
50-
docker run --rm -t --net=none -v "${PWD}:/tmp" leplusorg/mail asciidoc -o output.html intput.mail
34+
docker run --rm -t --net=none -v "${PWD}:/tmp" leplusorg/mail messages maildir
5135
```
5236

5337
## Software Bill of Materials (SBOM)

0 commit comments

Comments
 (0)