summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Smrž <roman.smrz@seznam.cz>2024-07-06 12:20:54 +0200
committerRoman Smrž <roman.smrz@seznam.cz>2024-07-06 12:23:15 +0200
commitc7f64b37e6442504fe5c41dbce6e7078cb434f31 (patch)
treed3543378fad3db70fdb70ba268643a1480911580
parent0a8b9157d4204115530f2981ff188d532c8426a5 (diff)
Readme: reformat command descriptions as definition lists
-rw-r--r--README.md68
1 files changed, 35 insertions, 33 deletions
diff --git a/README.md b/README.md
index 0d9919d..e69332d 100644
--- a/README.md
+++ b/README.md
@@ -71,27 +71,27 @@ discovery1.erebosprotocol.net> hello
### Messaging
`/peers`
-List peers with direct network connection. Peers are discovered automatically
-on local network or can be manually added.
+: List peers with direct network connection. Peers are discovered automatically
+ on local network or can be manually added.
`/contacts`
-List known contacts (see below).
+: List known contacts (see below).
`/conversations`
-List started conversations with contacts or other peers.
+: List started conversations with contacts or other peers.
`/<number>`
-Select conversation, contact or peer `<number>` based on the last
-`/conversations`, `/contacts` or `/peers` output list.
+: Select conversation, contact or peer `<number>` based on the last
+ `/conversations`, `/contacts` or `/peers` output list.
`<message>`
-Send `<message>` to selected conversation.
+: Send `<message>` to selected conversation.
`/history`
-Show message history of the selected conversation.
+: Show message history of the selected conversation.
`/details`
-Show information about the selected conversations, contact or peer.
+: Show information about the selected conversations, contact or peer.
### Chatrooms
@@ -114,21 +114,22 @@ contacts to contact list (similar to bluetooth device pairing). Before adding
new contact, list peers using `/peers` command and select one with `/<number>`.
`/contacts`
-List already added contacts.
+: List already added contacts.
`/contact-add`
-Add selected peer as contact. Six-digit verification code will be computed
-based on peer keys, which will be displayed on both devices and needs to be
-checked that both numbers are same. After that it needs to be confirmed using
-`/contact-accept` to finish the process.
+: Add selected peer as contact. Six-digit verification code will be computed
+ based on peer keys, which will be displayed on both devices and needs to be
+ checked that both numbers are same. After that it needs to be confirmed using
+ `/contact-accept` to finish the process.
`/contact-accept`
-Confirm that displayed verification codes are same on both devices and add the
-selected peer as contact. The side, which did not initiate the contact adding
-process, needs to select the corresponding peer with `/<number>` command first.
+: Confirm that displayed verification codes are same on both devices and add
+ the selected peer as contact. The side, which did not initiate the contact
+ adding process, needs to select the corresponding peer with `/<number>`
+ command first.
`/contact-reject`
-Reject contact request or verification code of selected peer.
+: Reject contact request or verification code of selected peer.
### Attach other devices
@@ -147,37 +148,38 @@ Before attaching device, list peers using `/peers` command and select the
target device with `/<number>`.
`/attach`
-Attach current device to the selected peer. After the process completes the
-owner of the selected peer will become owner of this device as well. Six-digit
-verification code will be displayed on both devices and the user needs to check
-that both are the same before confirmation using the `/attach-accept` command.
+: Attach current device to the selected peer. After the process completes the
+ owner of the selected peer will become owner of this device as well.
+ Six-digit verification code will be displayed on both devices and the user
+ needs to check that both are the same before confirmation using the
+ `/attach-accept` command.
`/attach-accept`
-Confirm that displayed verification codes are same on both devices and complete
-the attachment process (or wait for the confirmation on the peer device). The
-side, which did not initiate the attachment process, needs to select the
-corresponding peer with `/<number>` command first.
+: Confirm that displayed verification codes are same on both devices and
+ complete the attachment process (or wait for the confirmation on the peer
+ device). The side, which did not initiate the attachment process, needs to
+ select the corresponding peer with `/<number>` command first.
`/attach-reject`
-Reject device attachment request or verification code of selected peer.
+: Reject device attachment request or verification code of selected peer.
### Other
`/peer-add <host> [<port>]`
-Manually add network peer with given hostname or IP address.
+: Manually add network peer with given hostname or IP address.
`/peer-add-public`
-Add known public network peer(s).
+: Add known public network peer(s).
`/peer-drop`
-Drop the currently selected peer. Afterwards, the connection can be
-re-established by either side.
+: Drop the currently selected peer. Afterwards, the connection can be
+ re-established by either side.
`/update-identity`
-Interactively update current identity information
+: Interactively update current identity information
`/quit`
-Quit the erebos tool.
+: Quit the erebos tool.
Storage