summaryrefslogtreecommitdiffstats
path: root/doc/afb-events-guide.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/afb-events-guide.md')
-rw-r--r--doc/afb-events-guide.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/afb-events-guide.md b/doc/afb-events-guide.md
index 488c52af..f24bef3f 100644
--- a/doc/afb-events-guide.md
+++ b/doc/afb-events-guide.md
@@ -1,5 +1,5 @@
-Guid for developing with events
--------------------------------
+Guide for developing with events
+================================
Signaling agents are services that send events to any clients that
subscribed for receiving it. The sent events carry any data.
@@ -8,6 +8,9 @@ To have a good understanding of how to write a signaling agent, the
actions of subscribing, unsubscribing, producing, sending, receiving
events must be described and explained.
+Overview of events
+------------------
+
The basis of a signaling agent is shown on the following figure:
![scenario of using events](signaling-basis.svg)