diff options
| author | Georg Lukas <georg@op-co.de> | 2017-01-02 10:49:44 +0100 |
|---|---|---|
| committer | Georg Lukas <georg@op-co.de> | 2017-01-02 10:49:44 +0100 |
| commit | acf401f44b75771f659931d3e177a6addae6a545 (patch) | |
| tree | 235dab4e84e8a079cca77b20003f02dfcb9e3d48 /README.md | |
| parent | 471a506dad79a389c9c2d8d8edd4be57512cd866 (diff) | |
| download | php-xmpp-invitation-acf401f44b75771f659931d3e177a6addae6a545.tar.gz | |
README: change names
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md index 9aa091c..16e3ed0 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,13 @@ part of the [Easy XMPP](https://wiki.xmpp.org/web/Easy_XMPP) initiative to improve the ["first contact"](https://wiki.xmpp.org/web/Easy_Onboarding#First_Contact) experience. -For the JID trump@xmpp.example, it will create the following page ([live example](https://yax.im/i/#trump@xmpp.example)): +For the JID vladimir@xmpp.example, it will create the following page ([live example](https://yax.im/i/#vladimir@xmpp.example)): -> ## Trump has invited you to chat +> ## Vladimir has invited you to chat > -> Add Trump to your contact list by clicking the following link: +> Add Vladimir to your contact list by clicking the following link: > -> [**[ Add Trump ]**](https://yax.im/i/#trump@xmpp.example) +> [**[ Add Vladimir ]**](https://yax.im/i/#vladimir@xmpp.example) > > If this link does not work, you need to install and configure an XMPP client, and visit this page again afterwards. > @@ -22,13 +22,13 @@ For the JID trump@xmpp.example, it will create the following page ([live example ## Principal operation - * User A clicks on the client's "Create Invitation" button - * The XMPP client creates a link according to [RFC 5122](https://tools.ietf.org/html/rfc5122), e.g. `xmpp:trump@xmpp.example?otr=23` - * The client automatically transforms the link into a landing page link by removing `xmpp:` and adding the address as an URI fragment to the hosted landing page, e.g. `https://www.xmpp.example/i/#trump@xmpp.example?otr=23` - * User A sends the resulting invitation link via E-Mail, SMS, QR-Code, [RFC 1149](https://tools.ietf.org/html/rfc1149) or any other means. - * User B opens the link in the browser, which has an "Add"/"Join" button linking to the `xmpp:` URI - * If user B has an XMPP client, it will handle the button click - * If user B does not have an XMPP client, they can install one and return to the link later + * Vladimir clicks on his XMPP client's "Create Invitation" button + * The XMPP client creates a link according to [RFC 5122](https://tools.ietf.org/html/rfc5122), e.g. `xmpp:vladimir@xmpp.example?otr=23` + * The client automatically transforms the link into a landing page link by removing `xmpp:` and adding the address as an URI fragment to the hosted landing page, e.g. `https://www.xmpp.example/i/#vladimir@xmpp.example?otr=23` + * Vladimir sends the resulting invitation link via E-Mail, SMS, QR-Code, [RFC 1149](https://tools.ietf.org/html/rfc1149) or any other means to user Donald. + * Donald opens the link in the browser, which has an "Add"/"Join" button linking to the `xmpp:` URI + * If Donald has an XMPP client, it will handle the button click and open the "Add to roster" dialog + * If Donald does not have an XMPP client, the link won't work. Donald must install a client and return to the link later ## Design decisions |
