miqro.js 0.1.0

package/README.md

@@ -0,0 +1,85 @@
+# Miqro
+
+A minimal, high-performance microservice engine built on [Bun](https://bun.sh/) and [Hono](https://hono.dev/).
+Designed to process webhooks and run scheduled cron jobs utilizing file-based workflow configurations.
+
+## Quick Start
+
+Create a new project automatically in your current directory:
+```bash
+bunx miqro init
+```
+
+This creates a `miqro.config.ts` and a `workflows/` directory.
+
+Start the development server with hot-reloading:
+```bash
+bunx miqro dev
+```
+
+## Commands
+
+- `miqro init`: Scaffolds `miqro.config.ts` and a `workflows/` directory.
+- `miqro dev`: Starts the engine in development mode with hot-reloading (`bun --watch`).
+- `miqro start`: Starts the engine dynamically for production.
+- `miqro build`: Compiles your project and workflows into a single standalone file at `./dist/index.js`.
+
+## Configuration
+
+The engine is configured via `miqro.config.ts` in your project root:
+
+```typescript
+// miqro.config.ts
+import type { MiqroConfig } from 'miqro.js';
+
+export default {
+  port: 3000,
+  workflowsDir: './workflows', // Directory containing workflows
+} satisfies MiqroConfig;
+```
+
+## Workflows
+
+Workflows belong in the directory specified by `workflowsDir`. 
+Miqro automatically discovers `.ts` or `.js` module exports and registers them.
+
+### Webhook Workflow
+
+Webhooks respond to `POST /webhook?workflowId={id}`. Authentication supports `none`, `apiKey`, or `bearer`.
+
+```typescript
+// workflows/example-webhook.ts
+import type { Workflow } from 'miqro.js';
+
+export default {
+  config: {
+    id: 'process-payment',
+    name: 'Payment Webhook',
+    auth: { type: 'apiKey', key: process.env.API_KEY || 'secret' }
+  },
+  execute: async (payload: any) => {
+    console.log(`Received payload!`, payload);
+  }
+} satisfies Workflow;
+```
+
+### Scheduled Cron Workflow
+
+If a workflow config provides a `schedule` property (a valid Cron string), it will be executed automatically.
+
+```typescript
+// workflows/example-cron.ts
+import type { Workflow } from 'miqro.js';
+
+export default {
+  config: {
+    id: 'hourly-sync',
+    name: 'Sync Database',
+    auth: { type: 'none' }, // Auth is required but ignored for cron tasks
+    schedule: '0 * * * *'   // Runs every hour
+  },
+  execute: async () => {
+    console.log(`Running background sync...`);
+  }
+} satisfies Workflow;
+```