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.