@warp-drive-mirror/core 5.10.0-alpha.1 → 5.10.0-alpha.12

package/README.md

@@ -8,13 +8,11 @@
     />
 </p>
 
-![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=version&style=flat&color=fdb155)
-![NPM Downloads](https://img.shields.io/npm/dm/ember-data.svg?style=flat&color=fdb155)
+![NPM Stable Version](https://img.shields.io/npm/v/%40warp-drive%2Fcore/latest?label=version&style=flat&color=fdb155)
+![NPM Downloads](https://img.shields.io/npm/dm/%40warp-drive%2Fcore.svg?style=flat&color=fdb155)
 ![License](https://img.shields.io/github/license/warp-drive-data/warp-drive.svg?style=flat&color=fdb155)
-[![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=fdb155)](https://discord.gg/zT3asNS
-)
-[![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=fdb155)](https://discord.gg/PHBbnWJx5S
-)
+[![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=fdb155)](https://discord.gg/zT3asNS)
+[![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=fdb155)](https://discord.gg/PHBbnWJx5S)
 
 <p align="center">
   <br>
@@ -42,6 +40,26 @@ rich applications &mdash; letting you ship better experiences more quickly witho
 
 <br>
 
+## Usage
+
+`useRecommendedStore` produces a Store class with the recommended defaults; pair it with a cache such as [@warp-drive-mirror/json-api](https://warp-drive.io/api/@warp-drive-mirror/json-api/).
+
+```ts
+import { useRecommendedStore } from '@warp-drive-mirror/core';
+import { JSONAPICache } from '@warp-drive-mirror/json-api';
+
+export const AppStore = useRecommendedStore({
+  cache: JSONAPICache,
+  schemas: [
+    // resource schemas, see https://warp-drive.io/guides/the-manual/schemas/
+  ],
+});
+```
+
+This package is framework-agnostic; the bindings live in `@warp-drive-mirror/ember`, `@warp-drive-mirror/react` and `@warp-drive/vue`. Schemas describe the shape of your resources; the [Schemas guide](https://warp-drive.io/guides/the-manual/schemas/) covers writing them, and the [Setup guide](https://warp-drive.io/guides/configuration/) shows how each framework provides the Store to components.
+
+<br>
+
 ---
 
 <br>
@@ -55,3 +73,63 @@ Refer to the [Code of Conduct](https://github.com/warp-drive-data/warp-drive/blo
 ### License
 
 This project is licensed under the [MIT License](LICENSE.md).
+
+### ♥️ Credits
+
+ <details>
+   <summary>Brought to you with ♥️ love by <a href="https://emberjs.com" title="EmberJS">🐹 Ember</a></summary>
+
+  <style type="text/css">
+    img.project-logo {
+       padding: 0 5em 1em 5em;
+       width: 100px;
+       border-bottom: 2px solid #bbb;
+       margin: 0 auto;
+       display: block;
+     }
+    details > summary {
+      font-size: 1.1rem;
+      line-height: 1rem;
+      margin-bottom: 1rem;
+    }
+    details {
+      font-size: 1rem;
+    }
+    details > summary strong {
+      display: inline-block;
+      padding: .2rem 0;
+      color: #000;
+      border-bottom: 3px solid #bbb;
+    }
+
+    details > details {
+      margin-left: 2rem;
+    }
+    details > details > summary {
+      font-size: 1rem;
+      line-height: 1rem;
+      margin-bottom: 1rem;
+    }
+    details > details > summary strong {
+      display: inline-block;
+      padding: .2rem 0;
+      color: #555;
+      border-bottom: 2px solid #555;
+    }
+    details > details {
+      font-size: .85rem;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      details > summary strong {
+        color: #fff;
+      }
+    }
+    @media (prefers-color-scheme: dark) {
+      details > details > summary strong {
+        color: #afaba0;
+      border-bottom: 2px solid #afaba0;
+      }
+    }
+  </style>
+</details>

package/dist/{-private-D-EWCVEr.js → -private-CjK1Dmuh.js}

@@ -1,5 +1,5 @@
-import { a as setTransient, r as peekTransient, t as getOrSetGlobal } from "./-private-Bf-s5frd.js";
-import { f as setPromiseResult, o as DOMError, u as getPromiseResult } from "./request-Do_sEHfb.js";
+import { getOrSetGlobal, peekTransient, setTransient } from "./types/-private.js";
+import { f as setPromiseResult, o as DOMError, u as getPromiseResult } from "./request-Di274pQz.js";
 import { getGlobalConfig, macroCondition } from "@embroider/macros";
 
 //#region src/signals/reactivity/configure.ts
@@ -3527,4 +3527,4 @@ function getPromiseState(promise) {
 
 //#endregion
 export { ARRAY_SIGNAL as A, createInternalMemo as C, notifyInternalSignal as D, makeInitializer as E, setupSignals as M, waitFor as N, peekInternalSignal as O, willSyncFlushWatchers as P, consumeInternalSignal as S, getOrCreateInternalSignal as T, entangleSignal as _, getPaginationState as a, signal as b, getPaginationCache as c, getRequestState as d, createSignalDescriptor as f, entangleInitiallyStaleSignal as g, defineSignal as h, getPaginationLinks as i, OBJECT_SIGNAL as j, withSignalStore as k, DISPOSE as l, defineNonEnumerableSignal as m, createPaginationLinksSubscription as n, clearPaginationCache as o, defineGate as p, createPaginationSubscription as r, defaultPageHints as s, getPromiseState as t, createRequestSubscription as u, gate as v, createInternalSignal as w, Signals as x, memoized as y };
-//# sourceMappingURL=-private-D-EWCVEr.js.map
+//# sourceMappingURL=-private-CjK1Dmuh.js.map