updated docs and metadata

This commit is contained in:
Daniel Fichtinger 2025-06-04 13:27:19 -04:00
parent 3ad71d8654
commit dc11c497e7
2 changed files with 33 additions and 4 deletions

View file

@ -4,14 +4,14 @@
consistent paragraph spacing while preserving markdown syntax, email headers,
sign-offs, and signature blocks.
By default, this script accepts its input on `stdin` and prints to `stdout`.
By default, the command accepts its input on `stdin` and prints to `stdout`.
This makes it well suited for use as a formatter with a text editor like Kakoune
or Helix. It has no dependencies besides the standard Python interpreter, and
was written and tested against Python 3.13.3.
or Helix.
<!--toc:start-->
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Output Example](#output-example)
- [Markdown Safety](#markdown-safety)
@ -37,6 +37,28 @@ was written and tested against Python 3.13.3.
- Use case: piping the output to `pandoc` to write a `text/html` message. See
[Markdown Safety](#markdown-safety).
## Installation
`mailfmt` is intended for use as a standaole tool. The package is available on
PyPI as `mailfmt`. I recommend using [uv](https://github.com/astral-sh/uv) or
`pipx` to install it so the `mailfmt` command is available on your path:
```sh
uv tool install mailfmt
```
Verify that the installation was successful:
```sh
mailfmt --help
```
The tool doesn't currently have any dependencies. Therefore, you can just
download and execute the
[mailfmt](https://git.sr.ht/~ficd/mailfmt/tree/main/item/mailfmt.py) script
directly. However, dependencies may be introduced later, so I recommend
installing with a Python package manager.
## Usage
```