Clarify some of the documentation

ssbc / ssb-peer-invites

A new ssb invite system to create invites without having a pub

MIT License

26 stars 2 forks source link

Open Powersource opened 5 years ago

Powersource commented 5 years ago

I checked the code to verify and it seems these things work differently than the readme made it sound (please clarify if I'm wrong):

The pubs we're using don't have to follow the inviter directly, just be within the inviter's hops count. Is there a limit from the pub's perspective?
The invite that you get, and later use, is actually a string (whereas the documentation makes it sound like create gives you a js object).

dominictarr commented 5 years ago

the pub needs to be within the host (inviter's) hop count by 1, so that it will also replicate the guest.

yes it's a string, for copy pasting... okay updated docs