diff --git a/README.md b/README.md index 3adcc52..e8945ec 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,40 @@ GitHub notifications managements, better - [ ] create a simple viewer with github.com/rivo/tview list, open, delete - [ ] Implement a ruleset + +```mermaid + +sequenceDiagram + +participant cli +participant memory +participant rules +participant cache +participant api + +cli ->> memory: start +memory ->> cache: read + +alt cache expired + cache ->> api: GET /notifications + api ->> cache: HTTP 200 +end + +cache ->> memory: parse + +loop each notification + activate rules + memory ->> rules: + rules ->> rules: filter + opt + rules ->> memory: modify + end + opt + rules ->> api: query + end + deactivate rules +end + +memory ->> cache: write +memory ->> cli: print +```