From 8307564827cf41f55377a393c97fa58e4db22dbe Mon Sep 17 00:00:00 2001 From: Francesco Luzzana Date: Tue, 13 Dec 2022 02:02:23 +0100 Subject: [PATCH] readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e5e137a..866f8f6 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,16 @@ ![fuoco](cover.jpg) -A small framework to document project on the soupboat using a shared flat markup list as source. +A small framework to document project on the soupboat using a shared flat markup list as source. Meant to be edited by users of the soupboat to document their things. + +It's a single file CMS. The syntax of this file is really minimal, and it works together with the linear nature of the list to organize the contents. There are just a couple of level of hierarchy, hence the idea of flat structure. + +``` +(title) +[section] +--> Notes +>>comment (TBD) +Normal text +``` + +Find it live on the [soupboat](https://hub.xpub.nl/soupboat/bonfire/)