@linabase/js 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,137 @@
+# @linabase/js
+
+JavaScript/TypeScript client SDK for [Linabase](https://linabase.com), the self-hostable Supabase alternative.
+
+## Install
+
+```bash
+npm install @linabase/js
+```
+
+## Quick Start
+
+```typescript
+import { createClient } from "@linabase/js";
+
+const linabase = createClient({
+  url: "https://your-project.linabase.com",
+  anonKey: "lb_your_anon_key",
+});
+```
+
+## Database
+
+```typescript
+// Select
+const { data, error } = await linabase.from("posts").select("id, title, author(name)");
+
+// Insert
+await linabase.from("posts").insert({ title: "Hello", body: "World" });
+
+// Update
+await linabase.from("posts").update({ title: "Updated" }).eq("id", 1);
+
+// Delete
+await linabase.from("posts").delete().eq("id", 1);
+
+// Filters
+await linabase.from("posts")
+  .select()
+  .eq("status", "published")
+  .gte("created_at", "2026-01-01")
+  .order("created_at", { ascending: false })
+  .limit(10);
+
+// RPC (call Postgres functions)
+const result = await linabase.rpc("my_function", { arg1: "value" });
+```
+
+## Storage
+
+```typescript
+const storage = linabase.storage.from("avatars");
+
+// Upload
+await storage.upload("user-1/photo.jpg", file);
+
+// Download
+const blob = await storage.download("user-1/photo.jpg");
+
+// List files
+const files = await storage.list("user-1/");
+
+// Get public URL
+const url = storage.getPublicUrl("user-1/photo.jpg");
+
+// Signed URLs
+const { signedUrl } = await storage.createSignedUrl("user-1/photo.jpg", 3600);
+
+// Delete
+await storage.remove(["user-1/photo.jpg"]);
+```
+
+## Auth
+
+```typescript
+// Sign up
+const { user, session } = await linabase.auth.signUp({
+  email: "user@example.com",
+  password: "securepassword",
+});
+
+// Sign in
+const { user, session } = await linabase.auth.signIn({
+  email: "user@example.com",
+  password: "securepassword",
+});
+
+// Get current session
+const session = await linabase.auth.getSession();
+
+// Sign out
+await linabase.auth.signOut();
+
+// Listen for auth changes
+linabase.auth.onAuthStateChange((event, session) => {
+  console.log(event, session);
+});
+
+// OAuth
+await linabase.auth.signInWithOAuth({ provider: "google" });
+```
+
+## Schema Selection
+
+```typescript
+// Query a different schema (auth, storage, logs)
+const users = await linabase.schema("auth").from("auth_users").select();
+```
+
+## TypeScript
+
+```typescript
+// Generate types from your database schema
+const types = await linabase.generateTypes();
+```
+
+## Service Role (server-side only)
+
+```typescript
+const admin = createClient({
+  url: "https://your-project.linabase.com",
+  serviceRoleKey: "lb_your_service_role_key",
+});
+
+// Bypasses RLS
+const { data } = await admin.from("posts").select();
+```
+
+## Links
+
+- [Documentation](https://linabase.com/docs)
+- [GitHub](https://github.com/linabase/linabase)
+- [MCP Server](https://www.npmjs.com/package/@linabase/mcp-server)
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linabase/js",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "JavaScript/TypeScript client SDK for Linabase (database, storage, auth)",
   "license": "MIT",
   "type": "module",
@@ -13,7 +13,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "keywords": [
     "linabase",