aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorset <set>2020-08-28 15:33:27 +0200
committerset <set>2020-08-28 15:33:27 +0200
commit33e148be1c9cccd38c4c38ae7a2b4f65a84974c1 (patch)
tree164c597d53aa0cdb9118b868b91401ee29e48378
parentef986b137f2b5481d35a3b51cf79c4536e06dae8 (diff)
downloadn_core-33e148be1c9cccd38c4c38ae7a2b4f65a84974c1.tar.gz
n_core-33e148be1c9cccd38c4c38ae7a2b4f65a84974c1.zip
more adaptions in the readme
-rw-r--r--README.md20
1 files 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.