Commit aa9b649037f4e54ee19dc3d605650538f2bdbef7
add bash/js command prefixes in invite.md
Mel Heisey committed on 12/31/2018, 2:02:45 AMParent: ec2631bc4f97cd85ae243022f262ffeb1403b623
Files changed
| tmpl/apis/scuttlebot/invite.md | changed |
| tmpl/apis/scuttlebot/invite.md | |||
|---|---|---|---|
| @@ -7,13 +7,13 @@ | |||
| 7 | 7 … | ||
| 8 | 8 … | Create a new invite code. | |
| 9 | 9 … | ||
| 10 | 10 … | ```bash | |
| 11 | -create {n} | ||
| 11 … | +sbot create {n} | ||
| 12 | 12 … | ``` | |
| 13 | 13 … | ||
| 14 | 14 … | ```js | |
| 15 | -create(n, cb) | ||
| 15 … | +sbot.create(n, cb) | ||
| 16 | 16 … | ``` | |
| 17 | 17 … | ||
| 18 | 18 … | This produces an invite-code which encodes the sbot server's address, and a keypair seed. | |
| 19 | 19 … | The keypair seed is used to generate a keypair, which is then used to authenticate a connection with the sbot server. | |
| @@ -27,13 +27,13 @@ | |||
| 27 | 27 … | ||
| 28 | 28 … | Use an invite code. | |
| 29 | 29 … | ||
| 30 | 30 … | ```bash | |
| 31 | -accept {invitecode} | ||
| 31 … | +sbot accept {invitecode} | ||
| 32 | 32 … | ``` | |
| 33 | 33 … | ||
| 34 | 34 … | ```js | |
| 35 | -accept(invitecode, cb) | ||
| 35 … | +sbot.accept(invitecode, cb) | ||
| 36 | 36 … | ``` | |
| 37 | 37 … | ||
| 38 | 38 … | This connects to the server address encoded in the invite-code, then calls `use()` on the server. | |
| 39 | 39 … | It will cause the server to follow the local user. | |
| @@ -45,13 +45,13 @@ | |||
| 45 | 45 … | ||
| 46 | 46 … | Use an invite code created by this sbot instance (advanced function). | |
| 47 | 47 … | ||
| 48 | 48 … | ```bash | |
| 49 | -use --feed {feedid} | ||
| 49 … | +sbot use --feed {feedid} | ||
| 50 | 50 … | ``` | |
| 51 | 51 … | ||
| 52 | 52 … | ```js | |
| 53 | -use({ feed: }, cb) | ||
| 53 … | +sbot.use({ feed: }, cb) | ||
| 54 | 54 … | ``` | |
| 55 | 55 … | ||
| 56 | 56 … | This commands the receiving server to follow the given feed. | |
| 57 | 57 … | ||
Built with git-ssb-web