aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorset <set>2020-08-28 15:35:34 +0200
committerset <set>2020-08-28 15:35:34 +0200
commitda8246e8efece2397440a59c6011c4f832baa7b8 (patch)
treeebb06353520d96b9691c2b619c9f1f36d1692c48
parent66fe7376737aac50bac4e080b6a71ecddfb553ad (diff)
parent8daf41569c8a4d04db9fdfb8c01cdec49bba4eef (diff)
downloadn_core-da8246e8efece2397440a59c6011c4f832baa7b8.tar.gz
n_core-da8246e8efece2397440a59c6011c4f832baa7b8.zip
Merge branch 'master' into feature/fix_help
-rw-r--r--README.md24
1 files changed, 15 insertions, 9 deletions
diff --git a/README.md b/README.md
index fa50772..22f8a05 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ All messages may optionally include an `session` field. When you authorize again
|-------|------|-------------|
| `command` | string | The command N core should handle |
| `arguments` | string | The arguments to the command (i.e. all remaining text in the message - can be empty) |
-| `session` | string | The session id, should default to `null` |
+| `session` | string | The session id, should default to `"null"` |
### answer
The answer consists of an array of `reply` objects, an `success`-flag and a `session`-id provided by N core.
@@ -24,7 +24,7 @@ JSON object overview:
|-------|------|-------------|
| `reply` | array of `reply`-objects | The reply from N core |
| `success` | bool | Whether the command was successful |
-| `session` | string | A session id, defaults to `null` |
+| `session` | string | A session id, defaults to `"null"` |
#### `reply`
The `reply` object:
@@ -45,23 +45,29 @@ The `annotation` object:
The currently specified annotation types are enumerated below:
##### `none`
-The text should be printed as plain text. No extra content.
+The text should be printed as plain text.
+No extra content.
##### `bold`
-The text should be printed as bold. No extra content.
+The text should be printed bold.
+No extra content.
##### `italic`
-The text should be printed as italic. No extra content.
+The text should be printed italic.
+No extra content.
##### `strikethrough`
-The text should be printed as strikethrough. No extra content.
+The text should be printed strikethrough.
+No extra content.
##### `underline`
-The text should be printed as underline. No extra content.
+The text should be printed underlined.
+No extra content.
##### `command`
-The text should be printed as a command how did bridge will recognize it (e.g. prefix with '/').
+The text should be formated in a way to underlying platform of the bridge would 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.
+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.