From c46306ac2d1e8e0fb6dc60e2fcc1a79251d3c275 Mon Sep 17 00:00:00 2001 From: morelazers Date: Wed, 5 Apr 2023 17:12:19 +0200 Subject: [PATCH] feat: README --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f49408e --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# %blog + +%blog lets you create and serve a simple html website from your ship. + +## Features + +- Markdown support +- Custom CSS themes +- Drafts +- Serve your %blog from the same domain as your ship with zero config + +## Installation + +Install %blog with + +``` +|install ~hanrut-sillet-dachus-tiprel blog +``` + +## Export + +You can export your %blog with `:blog|export` in the dojo. This will create a folder inside your blog desk called `/export`. + +To see it, ensure you have mounted the blog desk with `|mount %blog`. \ No newline at end of file