@tsonic/efcore-sqlite 10.0.12 → 10.0.20

package/README.md

@@ -1,5 +1,60 @@
 # @tsonic/efcore-sqlite
 
-TypeScript type definitions for `Microsoft.EntityFrameworkCore.Sqlite` (+ dependencies) for .NET 10.
+TypeScript type definitions for **EF Core SQLite provider** (`Microsoft.EntityFrameworkCore.Sqlite` + dependencies) for **.NET 10**.
 
-Generated by `tsbindgen` from NuGet packages and intended for use with the Tsonic compiler.
+Generated by `tsbindgen` from NuGet assemblies and intended for use with the **Tsonic** compiler (TypeScript → .NET).
+
+## What this package is (and isn’t)
+
+- ✅ TypeScript bindings for the **SQLite provider** (and its required dependency assemblies).
+- ❌ Not a JavaScript runtime module (the `.js` files are module stubs for type-only use).
+- ✅ You still need the real **.NET assemblies** via NuGet in your Tsonic workspace.
+
+## Install (types)
+
+```bash
+npm install @tsonic/efcore-sqlite @tsonic/efcore @tsonic/dotnet @tsonic/core
+```
+
+## Use with Tsonic (recommended)
+
+Use `tsonic add nuget` and pass this package as the `types` argument:
+
+```bash
+tsonic add nuget Microsoft.EntityFrameworkCore.Sqlite <version> @tsonic/efcore-sqlite
+```
+
+## Imports
+
+Provider APIs are exported under the `Microsoft.EntityFrameworkCore` namespace module in this package:
+
+```ts
+import { SqliteDbContextOptionsBuilderExtensions } from "@tsonic/efcore-sqlite/Microsoft.EntityFrameworkCore.js";
+```
+
+You’ll typically also import EF Core’s base types from `@tsonic/efcore`:
+
+```ts
+import { DbContextOptionsBuilder } from "@tsonic/efcore/Microsoft.EntityFrameworkCore.js";
+```
+
+## Example (UseSqlite)
+
+```ts
+import { DbContextOptionsBuilder } from "@tsonic/efcore/Microsoft.EntityFrameworkCore.js";
+import { SqliteDbContextOptionsBuilderExtensions } from "@tsonic/efcore-sqlite/Microsoft.EntityFrameworkCore.js";
+
+const builder = new DbContextOptionsBuilder();
+SqliteDbContextOptionsBuilderExtensions.UseSqlite(builder, "Data Source=app.db");
+const options = builder.Options;
+```
+
+## Versioning
+
+This repo is versioned by **.NET major**:
+
+- .NET 10 → npm: `@tsonic/efcore-sqlite@10.x`
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsonic/efcore-sqlite",
-  "version": "10.0.12",
+  "version": "10.0.20",
   "description": "TypeScript type definitions for Microsoft.EntityFrameworkCore.Sqlite (+ dependencies) for .NET 10",
   "type": "module",
   "keywords": [
@@ -19,9 +19,9 @@
     "url": "https://github.com/tsoniclang/efcore-sqlite.git"
   },
   "peerDependencies": {
-    "@tsonic/core": "10.0.12",
-    "@tsonic/dotnet": "10.0.12",
-    "@tsonic/microsoft-extensions": "10.0.12",
-    "@tsonic/efcore": "10.0.12"
+    "@tsonic/core": "10.0.20",
+    "@tsonic/dotnet": "10.0.20",
+    "@tsonic/microsoft-extensions": "10.0.20",
+    "@tsonic/efcore": "10.0.20"
   }
 }