search

rarepress / nebulus

Virtual IPFS
https://nebulus.dev
MIT License
263 stars 15 forks source link

Readme Typo? #5

Open ROBERT-MCDOWELL opened 3 years ago

ROBERT-MCDOWELL commented 3 years ago

You can use the upload event to achieve this:

await nebulus.connect() nebulus.on("push", (cid) => { // do something here })

Because the upload event fires when a CID is successfully found on an IPFS gateway (ipfs.io), you can be sure that it will be pinned for at least a while.

But in your code the event is "push", not "upload", did I miss something?

skogard commented 3 years ago

Thanks for pointing it out. I originally had named them upload and download but transitioned to push and pull concepts. They do the same thing, but I find that the push and pull based git analogy is much more intuitive and straightforward.

But forgot to update some part of the doc and just fixed it. Here's the diff: https://github.com/skogard/nebulus/commit/f7f425fd312ef0b2a4f1fe1ad3b7b5d84ade7ed5

ROBERT-MCDOWELL commented 3 years ago

ok great, sure push pull is more intuitive. however it would be maybe useful for some to describe that "push" includes "other terms commonly used in web and html world like upload etc.." same for "pull" etc... btw, your project is very promising, as it opens the door to an async full mesh web network and add another layer of encryption for data packets which can be detached from ipfs itself. I guess it will be easier to manage real time packets for live streaming and buffer for example, but many many other cases too. I hope a lot of developers will come to support nebulus.

skogard commented 3 years ago

Thanks, yeah I agree it would be great if it included more explanation. Feel free to send a PR, the documentation is here https://github.com/skogard/nebulus/blob/main/docs/README.md

Otherwise I'll try to add some more details next time I update the repo.

ROBERT-MCDOWELL commented 3 years ago

I think it's better you do it, as I'm pretty new here and you know much better your code than me :)