mobx-keystone 1.20.0 → 1.22.0

package/README.md

@@ -1,41 +1,41 @@
-<p align="center">
-  <img src="./apps/site/static/img/logo.png" height="128" />
-  <h1 align="center">mobx-keystone</h1>
-</p>
-<p align="center">
-  <i>A MobX powered state management solution based on data trees with first-class support for TypeScript, snapshots, patches and much more</i>
-</p>
-
-<p align="center">
-  <a aria-label="NPM version" href="https://www.npmjs.com/package/mobx-keystone">
-    <img src="https://img.shields.io/npm/v/mobx-keystone.svg?style=for-the-badge&logo=npm&labelColor=333" />
-  </a>
-  <a aria-label="License" href="./LICENSE">
-    <img src="https://img.shields.io/npm/l/mobx-keystone.svg?style=for-the-badge&labelColor=333" />
-  </a>
-  <a aria-label="Types" href="./packages/lib/tsconfig.json">
-    <img src="https://img.shields.io/npm/types/mobx-keystone.svg?style=for-the-badge&logo=typescript&labelColor=333" />
-  </a>
-  <br />
-  <a aria-label="CI" href="https://github.com/xaviergonz/mobx-keystone/actions/workflows/main.yml">
-    <img src="https://img.shields.io/github/actions/workflow/status/xaviergonz/mobx-keystone/main.yml?branch=master&label=CI&logo=github&style=for-the-badge&labelColor=333" />
-  </a>
-  <a aria-label="Codecov" href="https://codecov.io/gh/xaviergonz/mobx-keystone">
-    <img src="https://img.shields.io/codecov/c/github/xaviergonz/mobx-keystone?token=6MLRFUBK8V&label=codecov&logo=codecov&style=for-the-badge&labelColor=333" />
-  </a>
-  <a aria-label="Netlify Status" href="https://app.netlify.com/sites/mobx-keystone/deploys">
-    <img src="https://img.shields.io/netlify/c5f60bcb-c1ff-4d04-ad14-1fc34ddbb429?label=netlify&logo=netlify&style=for-the-badge&labelColor=333" />
-  </a>
-</p>
-
-> ### Full documentation can be found on the site:
->
-> ## [mobx-keystone.js.org](https://mobx-keystone.js.org)
-
-#### New! Y.js bindings for `mobx-keystone` are now available in the `mobx-keystone-yjs` package as well as a working example in the examples section of the online docs.
-
-#### New! Loro CRDT bindings for `mobx-keystone` are now available in the `mobx-keystone-loro` package with native move operation support for arrays, as well as a working example in the examples section of the online docs.
-
+<p align="center">
+  <img src="./apps/site/static/img/logo.png" height="128" />
+  <h1 align="center">mobx-keystone</h1>
+</p>
+<p align="center">
+  <i>A MobX powered state management solution based on data trees with first-class support for TypeScript, snapshots, patches and much more</i>
+</p>
+
+<p align="center">
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/mobx-keystone">
+    <img src="https://img.shields.io/npm/v/mobx-keystone.svg?style=for-the-badge&logo=npm&labelColor=333" />
+  </a>
+  <a aria-label="License" href="./LICENSE">
+    <img src="https://img.shields.io/npm/l/mobx-keystone.svg?style=for-the-badge&labelColor=333" />
+  </a>
+  <a aria-label="Types" href="./packages/lib/tsconfig.json">
+    <img src="https://img.shields.io/npm/types/mobx-keystone.svg?style=for-the-badge&logo=typescript&labelColor=333" />
+  </a>
+  <br />
+  <a aria-label="CI" href="https://github.com/xaviergonz/mobx-keystone/actions/workflows/main.yml">
+    <img src="https://img.shields.io/github/actions/workflow/status/xaviergonz/mobx-keystone/main.yml?branch=master&label=CI&logo=github&style=for-the-badge&labelColor=333" />
+  </a>
+  <a aria-label="Codecov" href="https://codecov.io/gh/xaviergonz/mobx-keystone">
+    <img src="https://img.shields.io/codecov/c/github/xaviergonz/mobx-keystone?token=6MLRFUBK8V&label=codecov&logo=codecov&style=for-the-badge&labelColor=333" />
+  </a>
+  <a aria-label="Netlify Status" href="https://app.netlify.com/sites/mobx-keystone/deploys">
+    <img src="https://img.shields.io/netlify/c5f60bcb-c1ff-4d04-ad14-1fc34ddbb429?label=netlify&logo=netlify&style=for-the-badge&labelColor=333" />
+  </a>
+</p>
+
+> ### Full documentation can be found on the site:
+>
+> ## [mobx-keystone.js.org](https://mobx-keystone.js.org)
+
+#### New! Y.js bindings for `mobx-keystone` are now available in the `mobx-keystone-yjs` package as well as a working example in the examples section of the online docs.
+
+#### New! Loro CRDT bindings for `mobx-keystone` are now available in the `mobx-keystone-loro` package with native move operation support for arrays, as well as a working example in the examples section of the online docs.
+
 ## Introduction
 
 `mobx-keystone` helps you build complex client-side apps with a single source of truth, mutable model code, and immutable traceability built in.
@@ -94,7 +94,7 @@ registerRootStore(store)
 - Built-in primitives for references, transactions, action middlewares, and undo/redo.
 - Strong TypeScript inference for models, snapshots, and actions.
 - Composable domain models that stay maintainable as app complexity grows.
-- Seamless integration with MobX and `mobx-react`.
+- Seamless integration with MobX and `mobx-react-lite`.
 
 ### What users are saying
 
@@ -116,29 +116,29 @@ This gives you mutability where it helps developer experience, plus immutable tr
 Trees can only be modified by actions that belong to the same subtree.
 Actions are replayable and can be distributed, and fine-grained changes can be observed as JSON patches.
 
-Because `mobx-keystone` uses MobX behind the scenes, it integrates naturally with [`mobx`](https://mobx.js.org) and [`mobx-react`](https://github.com/mobxjs/mobx-react).
+Because `mobx-keystone` uses MobX behind the scenes, it integrates naturally with [`mobx`](https://mobx.js.org) and [`mobx-react-lite`](https://github.com/mobxjs/mobx/tree/main/packages/mobx-react-lite).
 The snapshot and middleware system also makes it possible to replace a Redux reducer/store pair with model-driven state and connect Redux devtools.
 
 `mobx-keystone` consists of composable _models_ that capture domain state and behavior together.
 Model instances are created from props, protect their own updates, and reconcile efficiently when applying snapshots.
-
-## Requirements
-
-This library requires a more or less modern JavaScript environment to work, namely one with support for:
-
-- MobX 6, 5, or 4 (with its gotchas)
-- Proxies
-- Symbols
-- WeakMap/WeakSet
-
-In other words, it should work on mostly anything except _it won't work in Internet Explorer_.
-
-If you are using TypeScript, then version >= 4.2.0 is recommended, though it _might_ work with older versions.
-
-## Installation
-
-> `npm install mobx-keystone`
-
-> `yarn add mobx-keystone`
-
-> `pnpm add mobx-keystone`
+
+## Requirements
+
+This library requires a more or less modern JavaScript environment to work, namely one with support for:
+
+- MobX 6, 5, or 4 (with its gotchas)
+- Proxies
+- Symbols
+- WeakMap/WeakSet
+
+In other words, it should work on mostly anything except _it won't work in Internet Explorer_.
+
+If you are using TypeScript, then version >= 4.2.0 is recommended, though it _might_ work with older versions.
+
+## Installation
+
+> `npm install mobx-keystone`
+
+> `yarn add mobx-keystone`
+
+> `pnpm add mobx-keystone`