From 4f90c08f481bf1e60f058983b033cbf26ff0d265 Mon Sep 17 00:00:00 2001 From: Colin Okay Date: Mon, 13 Apr 2020 08:47:55 -0500 Subject: readme --- README.org | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) (limited to 'README.org') diff --git a/README.org b/README.org index 0c5c20d..fdf3076 100644 --- a/README.org +++ b/README.org @@ -2,17 +2,21 @@ Build better bots, for matrix! -* Event Handlers -** Special Variables -*** *room-id* +For an example of a bot made with granolin, see [[https://github.com/cbeo/posterbot][posterbot]] -The special variable =*room-id*= is available in your =handle-event= methods. -It will have the value of the Matrix room id in which the event occured. It -will be =nil= if the event is not a room state nor timeline/message event. +** TODO Defing a Bot -For example: +** TODO Event Handlers +*** Special Variables +**** *room-id* -#+begin_src common-lisp -(defmethod handle-event :after ((cli echo-bot) (ev text-message-event)) - (send-text-message cli *room-id* (msg-body ev))) -#+end_src + The special variable =*room-id*= is available in your =handle-event= methods. + It will have the value of the Matrix room id in which the event occured. It + will be =nil= if the event is not a room state nor timeline/message event. + + For example: + + #+begin_src common-lisp + (defmethod handle-event :after ((cli echo-bot) (ev text-message-event)) + (send-text-message cli *room-id* (msg-body ev))) + #+end_src -- cgit v1.2.3