search

automerge / hypermerge

Build p2p collaborative applications without any server infrastructure in Node.js
MIT License
1.28k stars 66 forks source link

please update documentation #26

Closed jwverzijden closed 4 years ago

jwverzijden commented 5 years ago

I am having a hard time figuring out how to properly use this module, the documentation is for version 1.0.2 but the current version is 0.4.0

even the "basic setup" in the readme is not working...

const { Repo } = require( "hypermerge" );
const repo = new Repo({ path, storage });
// TypeError: Repo is not a constructor
// Repo is undefined

am I doing something wrong?

jwverzijden commented 5 years ago

Apparently on npm the version of the module is 0.4.0.

pvh commented 5 years ago

Thanks for the feedback! I should spend a bit of time updating READMEs and cutting a new release on hypermerge for sure. I'm currently living off the github master which is a bit unhealthy. I'm going to leave this issue open to remind me and schedule some time for this some time this week.

decentral1se commented 5 years ago

That would be great! Thanks a lot @pvh. I'm going to try using this library with some friends soon and can hopefully help out with some documentation patches where things are fuzzy (and we actually know whats going on :sweat_smile:)

crapthings commented 5 years ago

yes need more information

jankaszel commented 4 years ago

any way we can help, @pvh? i'm relatively new to hypermerge, but as i'm using it for my research, i'd be glad to work on the docs 🤝

pvh commented 4 years ago

Sure. Probably the best short-term approach is to jump into the Automerge Slack and ask questions about anything confusing and we can work together to get the docs whipped into shape.

100ideas commented 4 years ago

@falafeljan I am in the same boat with you. To get a little familiar with the api of hypermerge and automerge, I put together some simple playgrounds at repl.it. The hypermerge example pulls hypermerge from this repo so its up to date. Please fork and extend!