holepunchto/hyperbee

Update docs request

Closed this issue · 1 comments

flockonus commented

Hello,

It would make sense, and considerably lower the entry bar, to have readme.md being a complete example.

Right now the 2nd line errors with feed is not defined, and reading https://github.com/hypercore-protocol/hypercore it's not obvious where feed comes from either.

To finish up the readme, it would also be nice to just add a quick line to print all the keys or something, as not everyone knows how to handle db.createReadStream nor it's clear from docs

flockonus commented

Thanks! Excited to give a try again.

  • 🎉1