mirror of
https://github.com/kuhyx/utils.git
synced 2026-11-10 19:27:16 +01:00
Docs: correct stale 'not yet consumed' notes and old install URLs
Some checks failed
crdt-sync pre-commit / pre-commit (push) Waiting to run
crdt-sync tests / test (3.10) (push) Waiting to run
crdt-sync tests / test (3.11) (push) Waiting to run
crdt-sync tests / test (3.12) (push) Waiting to run
gatelock pre-commit / pre-commit (push) Has been cancelled
gatelock tests / test (3.10) (push) Has been cancelled
gatelock tests / test (3.11) (push) Has been cancelled
gatelock tests / test (3.12) (push) Has been cancelled
Some checks failed
crdt-sync pre-commit / pre-commit (push) Waiting to run
crdt-sync tests / test (3.10) (push) Waiting to run
crdt-sync tests / test (3.11) (push) Waiting to run
crdt-sync tests / test (3.12) (push) Waiting to run
gatelock pre-commit / pre-commit (push) Has been cancelled
gatelock tests / test (3.10) (push) Has been cancelled
gatelock tests / test (3.11) (push) Has been cancelled
gatelock tests / test (3.12) (push) Has been cancelled
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) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019KwUCPESvE5CjCtmUFz8xQ
This commit is contained in:
parent
5be99ab11d
commit
d69598880a
11
README.md
11
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/
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user