aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md
index 3f8e291..13cdd32 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,7 @@ The `annotation` object:
| Field | Type | Required? | Description |
|-------|------|-----------|-------------|
| `type` | string | yes | A part of the answer |
-| `extra` | string | no | Extra content specific to the annotation type |
+| `extra` | array of `reply`-objects | no | Extra content specific to the annotation type |
The currently specified annotation types are enumerated below:
@@ -60,7 +60,8 @@ The text should be printed as strikethrough. No extra content.
The text should be printed as underline. No extra content.
##### `command`
-The text should be printed as a command, meaning how did bridge will recognize it (e.g. prefix with '/'). No extra content.
+The text should be printed as a command how did bridge will recognize it (e.g. prefix with '/').
+Extra content: the description of the command.
##### `link`
The text should be formatted as a link. Extra content: the alt text for the uri - the uri should be the text itself, so that clients ignoring this annotation still show the real uri. \ No newline at end of file