Update README.md

This commit is contained in:
Jason Cosper 2023-12-21 15:35:23 -08:00 committed by GitHub
parent 6a3d544fad
commit 651d11954b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,2 +1,17 @@
# escape-hatch # Escape Hatch
Escape Hatch is a Python script that helps you export your Shuttlecraft posts to a Markdown file
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.