DavidMStraub / gramps-web-sync

Development version of a Gramps addon to synchronize Gramps Web with Gramps Desktop
GNU General Public License v3.0
11 stars 2 forks source link

Documentation (README.md) updates #8

Open emyoulation opened 1 year ago

emyoulation commented 1 year ago

Please add a screen capture to the README.me

image

also, the diocumented menu label doesn't match the GUI. The Submenu item reads: "Gramps Web Sync" image

emyoulation commented 1 year ago

The README.md shows:

Gramps Web API Sync Addon

Development version of a Gramps addon to synchronize a local family tree with a Gramps Web API instance

The link does not point to the Gramps Web folder with the setup doc. Are Gramps Web API and Gramps Web different things? If so, could you add the link to Gramps Web. And some differentiating text would be helpful.

DavidMStraub commented 1 year ago

You are right, but I would prefer having the pull request in addons-source merged, adding updated documentation in Gramps Wiki, and closing this repository.

The addon was originally called Web API Sync since it interacts directly with the Web API (here is an explanation of the difference) but I renamed it since these architectural subtleties are confusing to end users.