| README.mdView |
|---|
| 1 … | +# Scuttlebutt Guide |
| 2 … | + |
| 3 … | +_Looking to learn how to build in Scuttlebutt? There's currently no canonical resource, but here's a map of the known archipelago!_ |
| 4 … | + |
| 5 … | +[](https://en.wikipedia.org/wiki/A_Wizard_of_Earthsea) |
| 6 … | + |
| 7 … | +Have you found an Uncharted Isle? We'd love to hear about it. |
| 8 … | + |
| 9 … | +## Documentation |
| 10 … | + |
| 11 … | +[scuttlebot.io](http://scuttlebot.io/) - has great details about sbot and ssb-client (and other modules) |
| 12 … | + |
| 13 … | +[ssbc.github.io](https://ssbc.github.io/docs) - a predecessor to scuttlebutt.io, much of the same content, has some other tutorials |
| 14 … | + |
| 15 … | +[pull-stream.github.io](https://pull-stream.github.io/) - a guide to the pull-stream ecosystem (scuttlebut uses pull-streams extensively) |
| 16 … | + |
| 17 … | + |
| 18 … | +## Tutorials |
| 19 … | + |
| 20 … | +[github.com/don-smith/ssb-tutorial](https://github.com/don-smith/ssb-tutorial) - a command line intro that uses docker to spin up several sbots and get them talking to each other. |
| 21 … | + |
| 22 … | +[scuttlebot.io](http://scuttlebot.io/docs/basics/publish-a-message.html) - lots of code snippets, some background |
| 23 … | + - [post a message](http://scuttlebot.io/docs/basics/publish-a-message.html) |
| 24 … | + - [watch for new messages](http://scuttlebot.io/docs/advanced/watch-for-messages.html) |
| 25 … | + - [publish a blob](http://scuttlebot.io/docs/advanced/publish-a-file.html) | [read a blob](http://scuttlebot.io/docs/advanced/read-a-file.html) (blobs are files / attachments) |
|
| 26 … | + - many others |
| 27 … | + |
| 28 … | +[ssbc.github.io/scuttlebot/](http://ssbc.github.io/scuttlebot/) - (see HowTo Guides down side) more detail, but an odler reference |
| 29 … | + - [post a message](http://ssbc.github.io/docs/scuttlebot/howto-publish-a-post.html) (includes examples of mentioning, channels etc.) |
| 30 … | + - [update your profile](http://ssbc.github.io/docs/scuttlebot/howto-update-your-profile.html) |
| 31 … | + - [example of mentioning blobs in a post](http://ssbc.github.io/docs/scuttlebot/howto-publish-a-file.html) |
| 32 … | + - [set up a Pub Server manually](http://ssbc.github.io/docs/scuttlebot/howto-setup-a-pub.html) (an old guide) |
| 33 … | + |
| 34 … | + |
| 35 … | +## Module guides |
| 36 … | + |
| 37 … | +[scuttlebutt.nz/modules.html](https://www.scuttlebutt.nz/modules.html) - a great overview of modules organised by domain / stack-position |
| 38 … | + |
| 39 … | + |
| 40 … | + |
