@vibiz/sdk 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# @vibiz/sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The typed client for the [Vibiz Stack](https://app.vibiz.app/docs) API: projects, hosting and
+deploys, databases, sign-in, email, AI, usage, payments and more, with the same calls the `vibiz`
+CLI makes.
+
+```bash
+npm install @vibiz/sdk
+```
+
+```ts
+import { Vibiz } from '@vibiz/sdk';
+
+const vibiz = new Vibiz({ apiKey: process.env.VIBIZ_API_KEY!, baseUrl: 'https://app.vibiz.app' });
+
+const { project } = await vibiz.projects.create({ name: 'Acme Bakery' });
+const projects = await vibiz.projects.list();
+await vibiz.email.send(project.id, { to: 'you@example.com', subject: 'Hi', text: 'It works.' });
+```
+
+ESM with TypeScript types, Node 20+. The account key (`vz_sk_…`) is a secret: use it on servers,
+in scripts and in CI, never in a browser. For code that runs inside your app, use
+[`@vibiz/app`](https://www.npmjs.com/package/@vibiz/app).
+
+Docs: https://app.vibiz.app/docs