From d69598880ac857fd59216a65d5f124cd132fbf1d Mon Sep 17 00:00:00 2001 From: Krzysztof kuhy Rudnicki Date: Sat, 11 Jul 2026 23:31:41 +0200 Subject: [PATCH] Docs: correct stale 'not yet consumed' notes and old install URLs Both CRDT libs are now consumed (crdt_sync_dart: diet_guard app, workout_app, phone_app, todo; crdt-sync: diet-guard, screen-locker). Reconcile the sub-package READMEs' old standalone git URLs to the monorepo-subdirectory form, and bump the crdt_sync examples to v0.2.0. Co-Authored-By: Claude Opus 4.8 (1M context) Claude-Session: https://claude.ai/code/session_019KwUCPESvE5CjCtmUFz8xQ --- README.md | 11 ++++++----- crdt-sync/README.md | 2 +- crdt_sync_dart/README.md | 7 ++++--- gatelock/README.md | 2 +- 4 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c3326f3..a556191 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,9 @@ formerly-standalone repo, folded in here with full commit history preserved Dart/Flutter CRDT sync library (pub package name: `crdt_sync`, not published to pub.dev — consumed via a git dependency). Mirrors `crdt-sync` (below) -module-for-module and test-for-test. Not yet consumed by any app; planned -for screen-locker's workout sync. +module-for-module and test-for-test. Consumed by `diet_guard`'s app, +screen-locker's `workout_app`, `wake_alarm`'s `phone_app`, and `todo` (whose +notes are stored in the v0.2.0 `LogStore`). Consume via: ```yaml @@ -17,7 +18,7 @@ dependencies: crdt_sync: git: url: https://github.com/kuhyx/utils - ref: crdt_sync_dart-v0.1.0 + ref: crdt_sync_dart-v0.2.0 path: crdt_sync_dart ``` @@ -25,11 +26,11 @@ dependencies: Python CRDT sync library (package: `crdt_sync`, not published to PyPI). Same design as `crdt_sync_dart` (HLC clocks, per-field LWW, sticky-delete -tombstones). Not yet consumed by any app. +tombstones). Consumed by `diet-guard` and `screen-locker`. Consume via: ``` -crdt-sync @ git+https://github.com/kuhyx/utils@crdt-sync-v0.1.0#subdirectory=crdt-sync +crdt-sync @ git+https://github.com/kuhyx/utils@crdt-sync-v0.2.0#subdirectory=crdt-sync ``` ## guard-lib/ diff --git a/crdt-sync/README.md b/crdt-sync/README.md index 3ffe6e2..626b5a1 100644 --- a/crdt-sync/README.md +++ b/crdt-sync/README.md @@ -58,7 +58,7 @@ what makes it actually shared, rather than shaped around one app's schema. ## Install ```bash -pip install "crdt-sync @ git+https://github.com/kuhyx/crdt-sync@v0.1.0" +pip install "crdt-sync @ git+https://github.com/kuhyx/utils@crdt-sync-v0.2.0#subdirectory=crdt-sync" ``` ## Usage diff --git a/crdt_sync_dart/README.md b/crdt_sync_dart/README.md index 3d1fd00..0889f1a 100644 --- a/crdt_sync_dart/README.md +++ b/crdt_sync_dart/README.md @@ -27,14 +27,15 @@ for the concrete convergence-property tests. ## Install -Pin to a tag once this is pushed: +Consume via a git dependency on the `utils` monorepo: ```yaml dependencies: crdt_sync: git: - url: https://github.com/kuhyx/crdt_sync_dart - ref: v0.1.0 + url: https://github.com/kuhyx/utils + ref: crdt_sync_dart-v0.2.0 + path: crdt_sync_dart ``` ## Usage diff --git a/gatelock/README.md b/gatelock/README.md index 6da5c58..924ce73 100644 --- a/gatelock/README.md +++ b/gatelock/README.md @@ -18,7 +18,7 @@ now lives. ## Install ```bash -pip install "gatelock @ git+https://github.com/kuhyx/gatelock@v0.1.0" +pip install "gatelock @ git+https://github.com/kuhyx/utils@gatelock-v0.1.0#subdirectory=gatelock" ``` ## Usage