@korajs/devtools 0.0.0-canary-20261008174129

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dr. Obed Ehoneah
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# @korajs/devtools
+
+Browser DevTools extension for Kora.js. Inspect operations, trace conflict resolution decisions, monitor sync status, and debug your offline-first app in real time.
+
+## Install
+
+`korajs` already depends on `@korajs/devtools`; apps only turn it on. Install it directly to use
+the building blocks (`Instrumenter`, `EventBuffer`, the panel renderer) in your own tooling:
+
+```bash
+pnpm add -D @korajs/devtools@beta
+```
+
+## Enable
+
+<!-- docs-check: standalone -->
+```typescript
+import { createApp, defineSchema, t } from 'korajs'
+
+const schema = defineSchema({ version: 1, collections: { todos: { fields: { title: t.string() } } } })
+
+const app = createApp({
+  schema,
+  devtools: import.meta.env.DEV,
+})
+```
+
+With `devtools: true`, Kora records instrumentation events and:
+
+- mounts an in-page overlay, toggled with `Ctrl+Shift+K` (`Cmd+Shift+K` on macOS);
+- forwards events to the browser extension. The extension is not published to a store yet: build
+  it with `pnpm --filter @korajs/devtools build` in the Kora repository and load
+  `packages/devtools/dist/extension` as an unpacked extension in a Chromium browser.
+
+## Panels
+
+- **Timeline**: recorded events in order, color-coded by type.
+- **Conflicts**: every merge conflict with its strategy, tier, inputs and result.
+- **Operations**: operations created on this device and applied from sync, with payload, node,
+  sequence number and causal dependencies.
+- **Network**: connection state and quality, operations sent and received, last sync, and a
+  version vector derived from the recorded operations.
+
+The panels show events recorded since the page loaded. The complete event catalog is in the
+[DevTools API reference](https://korajs.dev/api/devtools#events).
+
+## License
+
+MIT