readme

Scuttlebot is a cryptographically secure, peer to peer, eventually consistent distributed technology influenced by kappa database architecture. These docs are open source, as is scuttlebot, created for participants, by participants. They're being created to make the experience with the network easier to use, quicker to understand and faster to contribute to as it's being built.

These docs are hosted on docs.gitmx.com.

doc goals

• ☐ How to install sbot
• ☐ How to install node
• ☐ How to choose a client (and the differences between them)
• ☐ How to use git-ssb
• ☐ Philosophy: Here's why bother now, not mañana
• ☐ pull-stream ex. from sbot api
• ☑ Current development team
• ☐ How to support the project
• ☐ How to set up a pub
• ☐ What's with the name? Project history
• ☑ How does sbot compare to urbit, cjdns, ipfs, zeronet
• ☐ How do I log in/out?
• ☐ What if I lose my private key?
• ☐ Known issues

building

To build these docs

npm install && sh ipm
node index.js
node serve

and navigate to localhost:3333 to view the docs site