search

hyperhyperspace / hyperhyperspace-core

A library to create p2p applications, using the browser as a full peer.
https://www.hyperhyperspace.org
MIT License
195 stars 12 forks source link

please put usage examples at the top of the readme #6

Closed bionicles closed 3 years ago

bionicles commented 3 years ago

would you please be openminded to put a code block near the top of the readme which explains how one would set this up and use it?

that would make it easier to evaluate and understand the API

sbazerque commented 3 years ago

Thanks for the suggestion! We'll add a code example to try to clarify it a bit more.

sbazerque commented 3 years ago

OK, tried but I feel a self contained code example would be a bit too long at the top of the README file.

But I added a TLDR-style sentence, with a link to the shortest example we have.

Do you feel it is a bit clearer now, @bionicles?

bionicles commented 3 years ago

definitely helps!