Commit 21ae23f01fae8bf8697229c0ae69a68842b2e368
fix some missing "user" mentions
mixmix committed on 2/4/2019, 12:51:20 AMParent: d7f18bb72566f32143d78451ca1a2eefb974f3ef
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -15,19 +15,19 @@ | ||
| 15 | 15 … | * hard to tell if growth was word of mouth or not |
| 16 | 16 … | |
| 17 | 17 … | ## usage |
| 18 | 18 … | |
| 19 | -With user invites, you can create invites without having a pub. | |
| 20 | -However, your local sbot needs to support user invites. | |
| 19 … | +With peer invites, you can create invites without having a pub. | |
| 20 … | +However, your local sbot needs to support peer invites. | |
| 21 | 21 … | that requires installing the following, if you havn't already: |
| 22 | 22 … | |
| 23 | 23 … | ``` |
| 24 | 24 … | sbot plugins.install ssb-device-address |
| 25 | 25 … | sbot plugins.install ssb-identities |
| 26 | 26 … | sbot plugins.install ssb-peer-invites |
| 27 | 27 … | ``` |
| 28 | 28 … | |
| 29 | -with user invites, you do not need to have your own pub server, | |
| 29 … | +with peer invites, you do not need to have your own pub server, | |
| 30 | 30 … | as long as you have a friend has one (that supports peer-invites). |
| 31 | 31 … | To enable peer-invites on your pub, install the same modules |
| 32 | 32 … | and restart, and also announce a public address using |
| 33 | 33 … | [ssb-device-address](https://github.com/ssbc/ssb-device-address) |
| @@ -56,12 +56,12 @@ | ||
| 56 | 56 … | >sbot peerInvites.acceptInvite {invite_code} |
| 57 | 57 … | accept_message... |
| 58 | 58 … | ``` |
| 59 | 59 … | |
| 60 | -## user invites - how it works | |
| 60 … | +## peer invites - how it works | |
| 61 | 61 … | |
| 62 | -host (user creating the invite) generates a _seed_, and publishes an invitation | |
| 63 | -message (`type:'peer-invite'`) for their guest (new user, receiving the invite) | |
| 62 … | +host (peer creating the invite) generates a _seed_, and publishes an invitation | |
| 63 … | +message (`type:'peer-invite'`) for their guest (new peer, receiving the invite) | |
| 64 | 64 … | The message may contain both a private and a reveal section. |
| 65 | 65 … | (private section is only readably be the guest, but reveal is published |
| 66 | 66 … | if they guest accepts the invite). |
| 67 | 67 … | |
| @@ -96,19 +96,19 @@ | ||
| 96 | 96 … | their friend to not be a jerk) `reveal` can be used to enhance this. It could for |
| 97 | 97 … | example - be used to assign someone a name before they are invited. |
| 98 | 98 … | |
| 99 | 99 … | private can be used for the benefit of the guest. it may contain a welcome message |
| 100 | -or links to threads or channels, or users to follow. | |
| 100 … | +or links to threads or channels, or peers to follow. | |
| 101 | 101 … | |
| 102 | 102 … | on success, cb is called with `{invite: msgId, seed: seed, pubs: [addr,...]}` |
| 103 | 103 … | this information can be sent to the guest as the invite! |
| 104 | 104 … | |
| 105 | 105 … | ### peerInvites.openInvite(invite, cb(err, invite_msg, content) |
| 106 | 106 … | |
| 107 | 107 … | "open" an invite. retrives the invite message created by the host (using `peerInvites.create`) |
| 108 | 108 … | and decrypt any encrypted values. since the invite may contain a welcome message, etc, |
| 109 | -user interfaces implementing user interfaces should process peer-invites in two steps. | |
| 110 | -firstly opening the invite, then accepting (on user confirmation) | |
| 109 … | +peer interfaces implementing peer interfaces should process peer-invites in two steps. | |
| 110 … | +firstly opening the invite, then accepting (on peer confirmation) | |
| 111 | 111 … | |
| 112 | 112 … | calling openInvite will not publish a message, but may make a network connection |
| 113 | 113 … | (if you do not already possess the `invite_msg` which you won't the first time) |
| 114 | 114 … | |
| @@ -120,9 +120,9 @@ | ||
| 120 | 120 … | ## example |
| 121 | 121 … | |
| 122 | 122 … | Alice wishes to invite Bob to her corner of the ssb |
| 123 | 123 … | network. But she is does not have a pub server. |
| 124 | -She creates a _user invite_, indicating that she | |
| 124 … | +She creates a _peer invite_, indicating that she | |
| 125 | 125 … | is creating an invite. This is just a message on her feed. |
| 126 | 126 … | |
| 127 | 127 … | ``` js |
| 128 | 128 … | var seed = random(32) //32 bytes of randomness |
Built with git-ssb-web