Added functional graph

.gitattributes

@@ -0,0 +1 @@
+*.png filter=lfs diff=lfs merge=lfs -text

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Romain Porte (MicroJoe)
+Copyright (c) 2015 - 2017 Romain Porte (MicroJoe)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -1,14 +1,23 @@
-hms_irc, the HAUM’s IRC microservice
-====================================
+hms_irc — Extensible IRC microservice
+=====================================
 
 .. image:: https://travis-ci.org/haum/hms_irc.svg?branch=master
     :target: https://travis-ci.org/haum/hms_irc
 
 .. image:: https://coveralls.io/repos/github/haum/hms_irc/badge.svg?branch=master
     :target: https://coveralls.io/github/haum/hms_irc?branch=master
 
-A microservice that follows routing keys on a RabbitMQ direct exchanger and
-publish messages on IRC depending on the messages received.
+This microservice uses the principle of *receivers* and *commands*. It will
+react into the IRC channel using receivers when data arrives from the watched
+AMQP topics, and will send data to AMQP topics upon specific user commands.
+
+Functional graph
+----------------
+
+Here is a concise graph of current *receivers* and *commands* implemented:
+
+.. image:: doc/functional_graph/hms_irc.png
+    :alt: Functional graph
 
 Using
 -----

doc/functional_graph/hms_irc.dot

@@ -0,0 +1,41 @@
+digraph G {
+	rankdir=LR;
+
+	{hms_irc [style=filled, fillcolor=bisque]};
+
+	// Receivers
+	receivers -> agenda;
+	agenda -> answer -> hms_irc;
+
+	receivers -> mastodon;
+	mastodon -> mention -> hms_irc;
+
+	receivers -> spacestatus;
+	spacestatus -> {spacestatus_answer [label=answer]} -> hms_irc;
+	spacestatus -> broadcast -> hms_irc;
+
+	// Commands
+	hms_irc -> commands;
+
+	commands -> "!agenda";
+	"!agenda" -> "add";
+	"!agenda" -> "add_sceance";
+	"!agenda" -> "remove";
+	"!agenda" -> "modify";
+
+	commands -> "!ping";
+
+	commands -> "!spacestatus";
+	"!spacestatus" -> "open";
+	"!spacestatus" -> "close";
+	"!spacestatus" -> "open_silent";
+	"!spacestatus" -> "close_silent";
+	"!spacestatus" -> "toggle";
+	"!spacestatus" -> "toggle_silent";
+
+	commands -> "!toot";
+
+	commands -> "!twitter";
+
+	commands -> "!updatesite";
+}