From 33e148be1c9cccd38c4c38ae7a2b4f65a84974c1 Mon Sep 17 00:00:00 2001 From: set Date: Fri, 28 Aug 2020 15:33:27 +0200 Subject: more adaptions in the readme --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fa50772..2026197 100644 --- a/README.md +++ b/README.md @@ -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. -- cgit v1.2.3-54-g00ecf From 8daf41569c8a4d04db9fdfb8c01cdec49bba4eef Mon Sep 17 00:00:00 2001 From: set Date: Fri, 28 Aug 2020 15:35:10 +0200 Subject: fixed type error for session id default value (it is a string with the value "null", not the json-value null --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2026197..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: -- cgit v1.2.3-54-g00ecf