@concavejs/runtime-bun 0.0.1-alpha.4

package/README.md

@@ -0,0 +1,81 @@
+# @concavejs/runtime-bun
+
+Library-first Bun runtime for Concave.
+
+## Install
+
+```bash
+bun add @concavejs/runtime-bun
+```
+
+## Quick start
+
+```ts
+import { createConcave } from "@concavejs/runtime-bun";
+
+const server = createConcave({
+  convexDir: "./convex",
+});
+
+await server.listen({ port: 3000 });
+console.log(server.url);
+```
+
+## Custom adapters
+
+```ts
+import { createConcave, SqliteDocStore, FsBlobStore } from "@concavejs/runtime-bun";
+
+const server = createConcave({
+  convexDir: "./convex",
+  docstore: new SqliteDocStore("./data/db.sqlite"),
+  blobstore: new FsBlobStore("./data/storage"),
+});
+
+await server.listen({ port: 3000, hostname: "127.0.0.1" });
+```
+
+You can also pass builders:
+
+```ts
+const server = createConcave({
+  convexDir: "./convex",
+  docstore: ({ runtime }) => {
+    if (runtime !== "bun") throw new Error("Unexpected runtime");
+    return new SqliteDocStore("./data/db.sqlite");
+  },
+  blobstore: () => new FsBlobStore("./data/storage"),
+});
+```
+
+## Module loading
+
+```ts
+const server = createConcave({
+  modules: {
+    "messages.ts": () => import("./convex/messages.ts"),
+    "tasks.ts": () => import("./convex/tasks.ts"),
+  },
+});
+```
+
+`modules` also accepts a single loader function or an array of loader sources.
+
+## API
+
+```ts
+type ConcaveOptions = {
+  convexDir?: string;
+  docstore?: DocStore | ((context: { runtime: "bun"; options: Readonly<ConcaveOptions> }) => DocStore);
+  blobstore?: BlobStore | ((context: { runtime: "bun"; options: Readonly<ConcaveOptions> }) => BlobStore);
+  schema?: "auto" | "skip";
+  modules?: ModuleLoader | Record<string, ModuleRegistryEntry> | Array<ModuleLoader | Record<string, ModuleRegistryEntry>>;
+};
+
+type Server = {
+  listen(options?: { port?: number; hostname?: string }): Promise<void>;
+  close(): Promise<void>;
+  readonly url: string;
+  readonly port: number;
+};
+```