Add a specification document

[slurdge]

If you disagree with some contents or have remarks, I can amend.

[berenm]

It would be better in doc instead of documentation, otherwise sounds OK. Thanks.

[berenm]

I would say that the goal is not exactly to synchronize local folders with remotes, but to synchronize repository hosting services together, and local folders would be a hosting service like another.

[slurdge]

I thought of that too, but I had a feeling that local folders, to be considered as "hosting" service, would be harder because we lack the meta data we have on other, online service providers, for example "private/not private", "own repo/fork", etc. I fear that if local is a hosting, then people would assume we have a way to do github->local->bitbucket without losing information which is not the case IMHO. Also, local can have nested structure and not online. But it's debatable.

[berenm]

Then the only way to not loose metadata would be to do remote (meaning: github / gilab / ...) to remote, which is not advertised here.

I think that if local folders are used as a source or destination (because local clone is always created even for remote to remote scenario), metadata should then be stored to disk in a specified format.

[berenm]

Or, not to support local folders at all but rather rely on the user creating the corresponding repositories in one of the hosting service and pushing the local repository manually.

[slurdge]

So, you mean we adverstise github<->gitlab sync ? I can amend doc for this.

[berenm]

So, you mean we adverstise github<->gitlab sync ? I can amend doc for this.

Yes please, I think it's what is advertised in the README as well and it's the simplest thing to implement right now. We can address using local folders as sources with all the metadata issue in the future. For backup purposes, local clones are done anyway when replicating remote repositories.