Rewrite the README as a user guide

[onechat] / socket.go

diff --git a/socket.go b/socket.go
index a306c5c81e00a6ec5f03391a4e9ae93fe7d4af6e..7b2da2b7a2077e11529c051efe4816de80827bf9 100644 (file)
--- a/socket.go
+++ b/socket.go
@@ -31,7 +31,9 @@ func checkSocketPath(path string) error {
 
 // SocketRequest is one line from a client: "send" with the text of a user
 // message, "interrupt", "stop" with the name of a subagent in Text, or
 
 // SocketRequest is one line from a client: "send" with the text of a user
 // message, "interrupt", "stop" with the name of a subagent in Text, or

-// "whatsapp" with the text after /whatsapp of a WhatsApp command.
+// "whatsapp" with the text after /whatsapp of a WhatsApp command, or "backup"
+// with the absolute output path in Text. The backup answer is a "backup" event
+// with the path and size, or an "error" event.

 type SocketRequest struct {
        Type string `json:"type"`
        Text string `json:"text,omitempty"`
 type SocketRequest struct {
        Type string `json:"type"`
        Text string `json:"text,omitempty"`