Skip to content

Commit

Permalink
docs: add a diagram to explore how the flow could work
Browse files Browse the repository at this point in the history
  • Loading branch information
nobe4 committed May 18, 2024
1 parent fedce4e commit 7733d42
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit 7733d42

Please sign in to comment.