Commit fe3ae12adbf9dfc9bd4146fa5708fee8f9297e46
document how to
Dominic Tarr committed on 12/23/2018, 1:09:01 AMParent: 1bf6749fd49324f237521f3e779c58fb5e03dfe8
Files changed
| README.md | changed |
| README.md | |||
|---|---|---|---|
| @@ -13,8 +13,50 @@ | |||
| 13 | 13 … | * sometimes pubs failed to follow back. | |
| 14 | 14 … | * some pubs more inviting than others "too open" | |
| 15 | 15 … | * hard to tell if growth was word of mouth or not | |
| 16 | 16 … | ||
| 17 … | +## usage | ||
| 18 … | + | ||
| 19 … | +With user invites, you can create invites without having a pub. | ||
| 20 … | +However, your local sbot needs to support user invites. | ||
| 21 … | +that requires installing the following, if you havn't already: | ||
| 22 … | + | ||
| 23 … | +``` | ||
| 24 … | +sbot plugins.install ssb-device-address | ||
| 25 … | +sbot plugins.install ssb-identities | ||
| 26 … | +sbot plugins.install ssb-user-invites | ||
| 27 … | +``` | ||
| 28 … | + | ||
| 29 … | +with user invites, you do not need to have your own pub server, | ||
| 30 … | +as long as you have a friend has one (that supports user-invites). | ||
| 31 … | +To enable user-invites on your pub, install the same modules | ||
| 32 … | +and restart, and also announce a public address using | ||
| 33 … | +[ssb-device-address](https://github.com/ssbc/ssb-device-address) | ||
| 34 … | + | ||
| 35 … | +then restart your sbot local server, there will be a bit of | ||
| 36 … | +index building, then you can create invites! | ||
| 37 … | + | ||
| 38 … | +``` | ||
| 39 … | +>sbot userInvites.create | ||
| 40 … | +invite_code... | ||
| 41 … | +``` | ||
| 42 … | +send `invite_code` to your friend and they can use | ||
| 43 … | + | ||
| 44 … | +``` | ||
| 45 … | +>sbot userInvites.openInvite {invite_code} | ||
| 46 … | +{ private:..., reveal:...} | ||
| 47 … | +`` | ||
| 48 … | +to see what you are inviting them to. this can contain a welcome | ||
| 49 … | +message. The `private` section is only readable by them, | ||
| 50 … | +but the `reveal` section is made public once they accept the invite. | ||
| 51 … | + | ||
| 52 … | +to actually accept the invite, they do: | ||
| 53 … | + | ||
| 54 … | +``` | ||
| 55 … | +>sbot userInvites.acceptInvite {invite_code} | ||
| 56 … | +accept_message... | ||
| 57 … | +``` | ||
| 58 … | + | ||
| 17 | 59 … | ## user invites - how it works | |
| 18 | 60 … | ||
| 19 | 61 … | host (user creating the invite) generates a _seed_, and publishes an invitation | |
| 20 | 62 … | message (`type:'user-invite'`) for their guest (new user, receiving the invite) | |
| @@ -241,4 +283,7 @@ | |||
| 241 | 283 … | # License | |
| 242 | 284 … | ||
| 243 | 285 … | MIT | |
| 244 | 286 … | ||
| 287 … | + | ||
| 288 … | + | ||
| 289 … | + | ||
Built with git-ssb-web