@lancedb/lancedb - npm Package Compare versions

Comparing version 0.4.13 to 0.4.15

package.json

 {
   "name": "@lancedb/lancedb",
-  "version": "0.4.13",
+  "version": "0.4.15",
   "main": "./dist/index.js",
@@ -62,3 +62,3 @@ "types": "./dist/index.d.ts",
     "chkformat": "prettier . --check",
-    "docs": "typedoc --plugin typedoc-plugin-markdown lancedb/index.ts",
+    "docs": "typedoc --plugin typedoc-plugin-markdown --out ../docs/src/js lancedb/index.ts",
     "lint": "eslint lancedb && eslint __test__",
@@ -71,7 +71,7 @@ "prepublishOnly": "napi prepublish -t npm",
   "optionalDependencies": {
-    "@lancedb/lancedb-darwin-arm64": "0.4.13",
-    "@lancedb/lancedb-linux-arm64-gnu": "0.4.13",
-    "@lancedb/lancedb-darwin-x64": "0.4.13",
-    "@lancedb/lancedb-linux-x64-gnu": "0.4.13",
-    "@lancedb/lancedb-win32-x64-msvc": "0.4.13"
+    "@lancedb/lancedb-darwin-arm64": "0.4.15",
+    "@lancedb/lancedb-linux-arm64-gnu": "0.4.15",
+    "@lancedb/lancedb-darwin-x64": "0.4.15",
+    "@lancedb/lancedb-linux-x64-gnu": "0.4.15",
+    "@lancedb/lancedb-win32-x64-msvc": "0.4.15"
   },
@@ -78,0 +78,0 @@ "dependencies": {

README.md

@@ -1,5 +0,37 @@
-# (New) LanceDB NodeJS SDK
+# LanceDB JavaScript SDK
 
-It will replace the NodeJS SDK when it is ready.
+A JavaScript library for [LanceDB](https://github.com/lancedb/lancedb).
 
+## Installation
+
+```bash
+npm install @lancedb/lancedb
+```
+
+This will download the appropriate native library for your platform. We currently
+support:
+
+- Linux (x86_64 and aarch64)
+- MacOS (Intel and ARM/M1/M2)
+- Windows (x86_64 only)
+
+We do not yet support musl-based Linux (such as Alpine Linux) or aarch64 Windows.
+
+## Usage
+
+### Basic Example
+
+```javascript
+import * as lancedb from "@lancedb/lancedb";
+const db = await lancedb.connect("data/sample-lancedb");
+const table = await db.createTable("my_table", [
+  { id: 1, vector: [0.1, 1.0], item: "foo", price: 10.0 },
+  { id: 2, vector: [3.9, 0.5], item: "bar", price: 20.0 },
+]);
+const results = await table.vectorSearch([0.1, 0.3]).limit(20).toArray();
+console.log(results);
+```
+
+The [quickstart](../basic.md) contains a more complete example.
+
 ## Development
@@ -9,3 +41,3 @@
 npm run build
-npm t
+npm run test
 ```
@@ -12,0 +44,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

378244

increased by0.29%

Number of package files

63

increased by1.61%

Lines of code

9167

increased by0.11%

Number of lines in readme file

82

increased by64%

Number of medium supply chain risk alerts

2

decreased by-33.33%

No dependency changes