Update README.md
This commit is contained in:
parent
6a3d544fad
commit
651d11954b
19
README.md
19
README.md
@ -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.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user