Commit acc5fc2c5308b4818c8fdfabedc4a27e010756c0
Explanation of scuttle terminology, repos and history to move to modules section (#36)
* added explanation: Secure-scuttlebutt vs scuttlebutt vs scuttlebot vs sbot? * ignore npm debug log * move scuttle terminology to modules sectionav8ta authored on 4/21/2017, 10:56:45 AM
Mikey committed on 4/21/2017, 10:56:45 AM
Parent: dea927468026e7d091af12342c633eb9db5b68b9
Files changed
| .gitignore | changed |
| modules.md | changed |
| modules.md | |||
|---|---|---|---|
| @@ -1,14 +1,30 @@ | |||
| 1 | 1 … | # Modules | |
| 2 | 2 … | ||
| 3 | -> isaacs (creator of npm) puts it very well: agreement is very difficult, so limit the amount of agreement necessary. | ||
| 3 … | +> Isaac Schlueter (creator of npm) puts it very well: agreement is very difficult, so limit the amount of agreement necessary. | ||
| 4 | 4 … | > | |
| 5 | 5 … | > i.e. write modules. | |
| 6 | 6 … | > | |
| 7 | 7 … | > With less agreement required, it's easier to find points of agreement, and so we can have _more_ agreements overall. | |
| 8 | 8 … | ||
| 9 | 9 … | - %88KMgyXpuyF1O1VtKjkycJ+R5j7sJ/DgFwLVAS19J4U=.sha256 | |
| 10 | 10 … | ||
| 11 … | +## Secure-scuttlebutt vs scuttlebutt vs scuttlebot vs sbot? | ||
| 12 … | +#### An explanation of terms, repos and project history | ||
| 13 … | + | ||
| 14 … | +- [`scuttlebutt`](https://github.com/dominictarr/scuttlebutt): a [`gossip protocol`](https://en.wikipedia.org/wiki/Gossip_protocol) that synchronises messages via a vector clock of per-node timestamps or sequences. Dominic got this name from an amazon paper ["Efficient Reconciliation and Flow Control for Anti-Entropy Protocols"](https://www.cs.cornell.edu/home/rvr/papers/flowgossip.pdf). This is the original scuttlebutt module which should now be known as "insecure scuttlebutt". This repo is generally no longer used by the ssb community. | ||
| 15 … | + | ||
| 16 … | +- [`secure-scuttlebutt`](https://github.com/ssbc/secure-scuttlebutt): this is the **database** part of **ssb**. Previously this term referred to the protocol/database as a whole. | ||
| 17 … | + | ||
| 18 … | +- [`scuttlebot`](https://github.com/ssbc/scuttlebot): this repo adds **networking behaviour** to the database (secure-scuttlebutt). | ||
| 19 … | + | ||
| 20 … | +- [`sbot`](https://github.com/ssbc/scuttlebot): short for **scuttlebot**, also the cli command name. | ||
| 21 … | + | ||
| 22 … | +There have been suggestions to rename some repos to better reflect their use and purpose: | ||
| 23 … | + | ||
| 24 … | +secure-scuttlebutt --> [`ssb-db `](https://github.com/ssbc/secure-scuttlebutt/issues/159) | ||
| 25 … | +scuttlebot --> [`ssb-server`](https://github.com/ssbc/scuttlebot/issues/378) | ||
| 26 … | + | ||
| 11 | 27 … | ## Streams | |
| 12 | 28 … | ||
| 13 | 29 … | - [`pull-stream`](https://pull-stream.github.io): minimal composable streams with lazy back pressure and error propagation | |
| 14 | 30 … | - [`mutant`](https://github.com/mmckegg/mutant): lazy observables and reactive html elements | |
Built with git-ssb-web