@casual-simulation/causal-tree-store-browser - npm Package Compare versions

Comparing version 0.9.40 to 0.10.0

package.json

 {
     "name": "@casual-simulation/causal-tree-store-browser",
-    "version": "0.9.40",
+    "version": "0.10.0",
     "description": "A causal tree store that supports browser environments",
@@ -44,6 +44,6 @@ "keywords": [
     "dependencies": {
-        "@casual-simulation/causal-trees": "^0.9.40",
+        "@casual-simulation/causal-trees": "^0.10.0",
         "dexie": "^2.0.4"
     },
-    "gitHead": "bfd87d1500756fe25b4fcb5f160266de677c23fa"
+    "gitHead": "b57e4496a7db0318959a138a12138ec69cfbc079"
 }

README.md

@@ -1,13 +0,25 @@
-# `causal-tree-store-browser`
+# Causal Tree Store Browser
 
-![npm (scoped)](https://img.shields.io/npm/v/@casual-simulation/causal-tree-store-browser.svg)
+[![npm (scoped)](https://img.shields.io/npm/v/@casual-simulation/causal-tree-store-browser.svg)](https://www.npmjs.com/package/@casual-simulation/causal-tree-store-browser)
 
-A causal tree store that supports browser environments
+A causal tree store that stores data in Indexed DB.
 
 ## Usage
 
-```
-const causalTreeStoreBrowser = require('causal-tree-store-browser');
+#### Create a Browser Causal Tree Store
 
-// TODO: DEMONSTRATE API
+```typescript
+import { BrowserCausalTreeStore } from '@casual-simulation/causal-tree-store-browser';
+
+demo();
+
+async function demo() {
+    const store = new BrowserCausalTreeStore();
+
+    await store.init();
+
+    const storedCausalTree = await store.get('example');
+
+    // TODO: Create a causal tree from the stored version.
+}
 ```

No alert changes

Improved metrics

Total package byte prevSize

15143

increased by2.32%

Number of lines in readme file

26

increased by85.71%

Dependency changes

• + Added@casual-simulation/causal-trees@0.10.4(transitive)

• + Added@casual-simulation/crypto@0.10.0(transitive)

• - Removed@casual-simulation/causal-trees@0.9.40(transitive)

• - Removed@casual-simulation/crypto@0.9.7(transitive)

• Updated@casual-simulation/causal-trees@^0.10.0