summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRoman Smrž <roman.smrz@seznam.cz>2026-01-13 20:41:55 +0100
committerRoman Smrž <roman.smrz@seznam.cz>2026-01-13 21:57:07 +0100
commit9e7a29e0f22afbfe5bdc0544735ad31d78758c7c (patch)
treec355d36bdbc819f7ac458f216fe6ce019de47681 /README.md
parentd6fe4ed34688940b3d6bc45d21022d3740b06996 (diff)
Commands to create and accept invites
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 28b203d..a84a3aa 100644
--- a/README.md
+++ b/README.md
@@ -150,7 +150,7 @@ are signed, so message author can not be forged.
history, but the chatroom will no longer be listed as available and no futher
updates for this chatroom will be collected or shared with other peers.
-### Add contacts
+### Contact list
To ensure the identity of the contact and prevent man-in-the-middle attack,
generated verification code needs to be confirmed on both devices to add
@@ -175,6 +175,17 @@ new contact, list peers using `/peers` command and select one with `/<number>`.
`/contact-reject`
: Reject contact request or verification code of selected peer.
+`/invite-contact <name>`
+: Create an invite in the form of URL, which can be sent via means outside of
+ the erebos protocol. The recipient can accept it using the `invite-accept`
+ command. After accepting, contact entry is created with the given `<name>`.
+ The created invite can be used only once.
+
+`/invite-accept <URL>`
+: Accept received URL-formatted invite. The erebos tool will try to find and
+ connect to a device belonging to the issuing identity to confirm the invite.
+ If successful, corresponding contact entry will be created.
+
### Attach other devices
Multiple devices can be attached to single identity to be used by the same