From 651d11954bcb714908c5b17db14c89f0d83cc27f Mon Sep 17 00:00:00 2001
From: Jason Cosper <boogah@gmail.com>
Date: Thu, 21 Dec 2023 15:35:23 -0800
Subject: [PATCH] Update `README.md`

---
 README.md | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index ff00acc..ff6e20c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,17 @@
-# escape-hatch
-Escape Hatch is a Python script that helps you export your Shuttlecraft posts to a Markdown file
+# Escape Hatch
+
+Escape Hatch is a Python script that helps you export your Shuttlecraft posts to a Markdown file.
+
+Requires the `markdownify` package to make everything look pretty:
+
+```
+pip install markdownify
+```
+
+Run it in the directory containing your Shuttlecraft install:
+
+```
+python escape_hatch.py > export.md
+```
+
+Better documentation soon? Maybe. Maybe not.