From 07e771072aeb2bb02c8732ec15a70c434d4c0e54 Mon Sep 17 00:00:00 2001
From: io42630 <ivan@olexyn.com>
Date: Fri, 23 Feb 2024 15:52:59 +0100
Subject: [PATCH] update doc

---
 README.adoc | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 README.md   |  8 --------
 2 files changed, 46 insertions(+), 8 deletions(-)
 create mode 100644 README.adoc
 delete mode 100644 README.md

diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..326fb49
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,46 @@
+= BurnsMail
+:stylesheet: ../shared/adoc-styles.css
+:toc:
+:toclevels: 4
+
+== Getting Started
+* run `build+recreate.sh`
+
+== Flow (trigger)
+* We trigger one of our workflows via REST to our App.
+
+== Flow (engine)
+* we have our own little engine, as defined in `process(flow)`.
+* it consists of the following steps:
+** `search` : the `Store` for `Message[]`
+** `map` : the `Message` to `AMail` (lazy or full, see `AMail`)
+** `filter` : the `AMail` (e.g. by _subject_)
+** `transform` : the `AMail` (e.g. set spam score)
+** `action` : on the `AMail` (e.g. move to folder)
+** `cleanup` : on the `Store` (e.g. flush some folder)
+
+== AMail
+* generally `AMail` is a proxy-less `String`-backed representation of a `Message`.
+
+== List of current Step Implementations
+
+=== Search
+* `FetchAll` : fetch all messages from some `Folder`
+* `SearchAnySubject` : search for any of the provided subjects in some `Folder`
+
+=== Map
+* TODO : doc
+
+=== Filter
+* TODO : doc
+
+=== Transform
+* `SetOpenAiScore` : set spam-score by asking _openai_
+
+=== Action
+* `MoveToFolder` : move the mail to some `Folder`
+
+=== Cleanup
+* `FlushFolders` : flush the provides `Folder` s
+
+
diff --git a/README.md b/README.md
deleted file mode 100644
index 4648f75..0000000
--- a/README.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# BurnsMail
-
-## Goals
-
-* connect to mailbox (OK)
-* connect to ollama
-* check mail (OK)
-* move to burn folder
\ No newline at end of file