search

yjs / yjs-demos

A collection of demos for Yjs
https://demos.yjs.dev
The Unlicense
729 stars 120 forks source link

Provide README files with explanations and PoD for examples #44

Closed mprinc closed 3 years ago

mprinc commented 3 years ago

Would be great if you could provide additional info overall for the demos but also separate README for each demo as otherwise, it is hard to explore them.

This is especially the case with similar demos like https://github.com/yjs/yjs-demos/blob/master/prosemirror and https://github.com/yjs/yjs-demos/tree/master/prosemirror-dat where you can understand the PoD only through package.json and even there the description property is the same (#45), so need to go to dependencies.

Surely, after some time spending "there" we can contribute PRs with it :)

dmonad commented 3 years ago

Hi @mprinc

Thanks, that is very valuable feedback! I added a readme to every demo and added a brief description of what is happening.

mprinc commented 3 years ago

Thank you @dmonad, I looked there and all is great; clear, lot of references and understanding! Thanks again, we are "bought"! :)