@livequery/core 2.0.99 → 2.0.101
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,8 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
Reactive local-first data primitives for browser clients.
|
|
4
4
|
|
|
5
|
+
This repository is the core library package, not an application. Changes here should preserve reusable public API behavior unless a task explicitly targets a breaking change.
|
|
6
|
+
|
|
5
7
|
This package provides the core building blocks behind Livequery collections: reactive document state, pluggable local storage, pluggable transporters, optimistic mutations, and typed inline filters.
|
|
6
8
|
|
|
9
|
+
## AI Agent Guidance
|
|
10
|
+
|
|
11
|
+
Repository-specific agent guidance lives in `AGENTS.md` and `copilot-instructions.md`.
|
|
12
|
+
|
|
13
|
+
- `AGENTS.md` is the implementation-focused guide for coding agents modifying this package.
|
|
14
|
+
- `copilot-instructions.md` provides repo-level instructions for Copilot when generating or reviewing code in this workspace.
|
|
15
|
+
- Both documents assume this repo is a library package, so agent changes should avoid app-specific scaffolding and should preserve public API compatibility by default.
|
|
16
|
+
- Agents generating consumer code should also follow the usage patterns documented below: create a shared `LivequeryCore`, initialize collections before querying, and subscribe to collection state instead of relying on one-time `.value` reads.
|
|
17
|
+
|
|
7
18
|
## Installation
|
|
8
19
|
|
|
9
20
|
```bash
|