From dc11c497e7ba1967f537ff4defd90c3fa15180c0 Mon Sep 17 00:00:00 2001
From: Daniel Fichtinger <daniel@ficd.ca>
Date: Wed, 4 Jun 2025 13:27:19 -0400
Subject: [PATCH] updated docs and metadata

---
 README.md      | 28 +++++++++++++++++++++++++---
 pyproject.toml |  9 ++++++++-
 2 files changed, 33 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index e09b662..fb5594a 100644
--- a/README.md
+++ b/README.md
@@ -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
 
 ```
diff --git a/pyproject.toml b/pyproject.toml
index e73335a..16b6704 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "mailfmt"
-version = "0.1.0"
+version = "1.0.0"
 description = "Plain text email formatter"
 readme = "README.md"
 authors = [
@@ -8,6 +8,13 @@ authors = [
 ]
 requires-python = ">=3.11"
 dependencies = []
+license = "ISC"
+license-files = ["LICENSE"]
+keywords = ["email", "formatter"]
+
+[project.urls]
+Repository = "https://git.sr.ht/~ficd/mailfmt"
+Homepage = "https://sr.ht/~ficd/mailfmt"
 
 [project.scripts]
 mailfmt = "mailfmt:main"