From 8d75b6a645c780f2738b65db4cf67a4bf749579a Mon Sep 17 00:00:00 2001
From: Jon Michael Aanes <jonjmaa@gmail.com>
Date: Wed, 22 Jan 2025 22:43:31 +0100
Subject: [PATCH] Documentation

---
 package_tracking/__init__.py | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/package_tracking/__init__.py b/package_tracking/__init__.py
index b6c9992..36b442e 100644
--- a/package_tracking/__init__.py
+++ b/package_tracking/__init__.py
@@ -1,8 +1,17 @@
 """# Package-tracking.
 
-Sample package tracking website.
+Small alternative frontend for tracking packages and parcels.
 
-Use the [Parcels API](https://parcelsapp.com/).
+Use the excellent [Parcels App API](https://parcelsapp.com/), and thus requires
+an API key.
+
+This was written specifically for embedding as an iframe into homepage
+applications like [Homepage](https://gethomepage.dev/) or [Dashy](https://dashy.to/).
+
+Once run, it exposes the following endpoints:
+
+- `/`: Base view, including a form for adding new parcels.
+- `/noninteraction`: Smaller view for embedding as iframe.
 """
 
 __all__ = ['__version__']