Commit 4c6c3551 authored by seykron's avatar seykron

Adds documentation

parent f9c93786
# eye-of-cthulhu
# Iris
![Iris](iris.png)
[Iris](telegram.me/Ir1sBot) es la mensajera de R'lyeh, es los ojos de Cthulhu en el ciberespacio.
Desde la superficie hasta las profundidades del Polo de Inaccesibilidad, [Iris](telegram.me/Ir1sBot)
recibe y comunica todo lo que pase en R'lyeh; es el único ser que puede entrar y salir del sueño de Cthulhu sin
perder la cordura.
Por eso la invocamos para que avise en el ciberespacio cuando hay novedades importantes en R'lyeh.
[Iris](telegram.me/Ir1sBot) nos avisará por Telegram cuando ocurran los siguientes eventos:
* Si se cae algún servicio de R'lyeh.
* Cuando haya un mensaje importante de la comunidad de R'lyeh.
A [Iris](telegram.me/Ir1sBot) hay que hablarle e invocarla de las siguientes maneras:
[/list_sources](src/main/kotlin/be/rlab/iris/domain/command/ListSources.kt) para que nos muestre la lista
de fuentes a las que podemos subscribirnos para esperar mensajes.
[/subscribe](src/main/kotlin/be/rlab/iris/domain/command/Subscribe.kt) para subscribirnos a alguna de las
fuentes de mensajes. Si la invocamos de esta forma en un grupo o canal, [Iris](telegram.me/Ir1sBot) nos
va a subscribir a los mensajes que envie el grupo o canal.
[/enable_notifications](src/main/kotlin/be/rlab/iris/domain/command/EnableNotifications.kt) para
activar las notificaciones de nuevos mensajes en un grupo o canal. Con este pedido debemos decirle
a [Iris](telegram.me/Ir1sBot) qué fuentes de mensajes debe observar para notificar mensajes al grupo
o canal.
[/inbox_read](src/main/kotlin/be/rlab/iris/domain/command/InboxRead.kt) para leer mensajes pendientes.
Si le pedimos esto a [Iris](telegram.me/Ir1sBot) en la soledad de nuestros mensajes privados, nos
leerá los mensajes destinados a nosotras. Si le pedimos que lea los mensajes en un grupo, nos leerá
los mensajes destinados a la comunidad.
[/inbox_count](src/main/kotlin/be/rlab/iris/domain/command/InboxCount.kt) para pedirle a
[Iris](telegram.me/Ir1sBot) que nos cuente cuántos mensajes tenemos pendientes y de qué fuentes.
iris.png

173 KB

Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment