Skip to content

2.0.0-beta

Pre-release
Pre-release

Choose a tag to compare

@github-actions github-actions released this 15 May 23:38
docs: rewrite README for the renamed/refocused plugin

The old README still described upstream `github-gitless-sync` v1.0.7:
upstream feature list, "available as a community plugin" install
flow that doesn't apply to the fork, link to Silvano's discussions
for contributions, no mention of the new author or the new repo URL.
After the rename to v2.0.0-beta the file was visibly stale.

Full rewrite around what the plugin actually is today:

  • Intro + comparison table vs obsidian-git, github-gitless-sync,
    Obsidian-GitHub-Sync, github-sync-multi-platform. Honest, not
    trash-talking.
  • Installation walkthrough that covers the parts users actually
    get stuck on: creating a fine-grained PAT with the exact
    permission setting, choosing "Only select repositories" instead
    of "All repositories", BRAT install for beta distribution,
    the Test-connection probe as the first real interaction.
  • Settings reference, group by group, with rationale on why each
    default is what it is (autoCanonicalizeTextFiles=false, configs
    off by default, data.json blocked, …).
  • Conflict resolution section flagged as "works but UX still
    rough" — honest about the beta state of the diff view.
  • Commands + vim-mode integration sketch (placeholder for the
    user to fill once they verify it).
  • Troubleshooting steps + common gotchas (fine-grained PAT scope
    404, Android paste whitespace, large-adoption foreground hint).
  • Acknowledgements crediting Silvano Cerza for the original idea +
    REST client + plugin scaffolding (~8% of current src/), with
    the exact attribution line copy-pasted from the source headers.
  • License clearly noted as AGPL-3.0 carried over.

Screenshot placeholders left as `<!-- SCREENSHOT: ... -->` HTML
comments so the user can drop in captures later without hunting
for the right spot.

405 lines, up from 141 — the extra length is mostly the install
walkthrough and the settings reference, both of which the old
README didn't cover.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>