Commit a1a62ab007bd365fedeb8fcaa561f0bc0971a43d
better readme
Dominic Tarr committed on 10/25/2016, 3:20:22 PMParent: 704f26822aea683181bd1a94a30e08df76f5d8b3
Files changed
| README.md | changed |
| README.md | |||
|---|---|---|---|
| @@ -1,10 +1,15 @@ | |||
| 1 | 1 … | # ssb-feed | |
| 2 | 2 … | ||
| 3 | 3 … | A publishing interface for scuttlebutt feeds. | |
| 4 | 4 … | ||
| 5 | -By default, [Scuttlebot](https://ssbc.github.io/scuttlebot/) uses a "master" identity/feed, which `sbot.publish()` will append new messages to. If you want to manipulate additional feeds, you can load the keypair and then use this library to do so. | ||
| 5 … | +Track the state necessary to publish ssb feeds. This is built into secure-scuttlebutt, | ||
| 6 … | +where it validates replicated messages, and it is also used "remotely" in patchbay. | ||
| 6 | 7 … | ||
| 8 … | +By default, [Scuttlebot](https://ssbc.github.io/scuttlebot/) uses a "master" identity/feed, | ||
| 9 … | +which `sbot.publish()` will append new messages to. If you want to manipulate additional feeds, | ||
| 10 … | +you can load the keypair and then use this library to do so. | ||
| 11 … | + | ||
| 7 | 12 … | ## Example | |
| 8 | 13 … | ||
| 9 | 14 … | ``` js | |
| 10 | 15 … | ||
Built with git-ssb-web