https://github.com/ssb-junkyard/ssb-feed

create a secure-scuttlebutt feed
https://github.com/ssb-junkyard/ssb-feed

Last synced: 4 months ago
JSON representation

create a secure-scuttlebutt feed

• Host: GitHub
• URL: https://github.com/ssb-junkyard/ssb-feed
• Owner: ssb-junkyard
• License: mit
• Created: 2015-03-22T02:05:52.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-01-11T20:52:18.000Z (about 6 years ago)
• Last Synced: 2024-05-17T15:16:39.792Z (9 months ago)
• Language: JavaScript
• Size: 50.8 KB
• Stars: 15
• Watchers: 17
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-peer-to-peer - ssb-feed

README

        
# ssb-feed

A publishing interface for scuttlebutt feeds.

Track the state necessary to publish ssb feeds. This is built into secure-scuttlebutt,

where it validates replicated messages, and it is also used "remotely" in patchbay.

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.

## Example

``` js

var ssbFeed = require('ssb-feed')

var ssbClient = require('ssb-client')

var ssbKeys = require('ssb-keys')

var alice = ssbKeys.generate()

ssbClient(function (err, sbot) {

  var feed = ssbFeed(sbot, alice)

  // Post to alice's feed

  feed.publish({

    type: 'post',

    text: 'hello world, I am alice.'

  }, function (err) { ... })

  // Also available:

  console.log(feed.id)

  console.log(feed.keys)

})

```

This example uses `ssb-client`, but, if you're embedding `scuttlebot` or the `secure-scuttlebutt` library into your process, you can use them locally.

## License

MIT