Share general review and documentation rules

[onechat] / README.rst

diff --git a/README.rst b/README.rst
index 8002ea095f9ea275e8ad56b4687c62aa5ee702f6..3c458d64089be27b3fcf427208ccc47c13f1fcb7 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -77,6 +77,14 @@ or Telegram:
 The session file gives full access to the account. If it leaks, remove
 the device in Linked devices on the phone.
 
 The session file gives full access to the account. If it leaks, remove
 the device in Linked devices on the phone.
 

+External events
+===============
+
+Use ``onechat notify --source CHECK --id EVENT --text TEXT`` to send
+external data to the root at its next turn. Add ``--agent-id ID`` to
+select a permanent child by its stable ID. Success means accepted, not
+processed. See ``onechat notify --help`` for the local test limits.
+

 User service
 ============
 
 User service
 ============
 


@@ -154,11 +162,14 @@ replies show with Markdown styles and tables. These lines are commands:
 ``/stop NAME``
    Stops the subagent NAME.
 
 ``/stop NAME``
    Stops the subagent NAME.
 

+``/image PATH [caption]``
+   Sends a JPEG, PNG, or WebP image. Quote a path with spaces.
+

 ``/whatsapp ...``
    The WhatsApp commands above.
 
 ``/whatsapp ...``
    The WhatsApp commands above.
 

-In Telegram, write as in the client. ``onechat help`` lists all
-commands.
+In Telegram, write as in the client, also with photos and image files.
+``onechat help`` lists all commands.

 
 *********************
  What the agent does
 
 *********************
  What the agent does


@@ -190,6 +201,18 @@ WhatsApp
    ask. It proposes to route a chat that is only about one area to the
    child of that area, and sets the route after you agree.
 
    ask. It proposes to route a chat that is only about one area to the
    child of that area, and sets the route after you agree.
 

+Images
+   Send a photo in Telegram, WhatsApp, or with ``/image`` to the agent.
+   Its memory keeps what the image shows, and it can look at an older
+   image again. Ask it to show an image or send one to a WhatsApp chat.
+
+Voice notes
+   The agent hears Telegram and WhatsApp voice notes through local
+   Whisper. Nix includes the small model. Outside Nix, set
+   ``voice.model`` in ``config.json`` and install ``whisper-cli``.
+   ``voice.transcriber`` selects another executable. No audio goes to a
+   transcription service.
+

 Schedules
    Ask for reminders and timed tasks, such as "every weekday at 8, tell
    me what my groups talked about". Each run uses the quota, so runs are
 Schedules
    Ask for reminders and timed tasks, such as "every weekday at 8, tell
    me what my groups talked about". Each run uses the quota, so runs are