From a202d9e36c8bf315402dddc954415e64ed17dc83 Mon Sep 17 00:00:00 2001 From: Ali Davut Date: Thu, 5 Mar 2026 03:51:38 +0300 Subject: [PATCH] Update README.md --- README.md | 38 +++++++++++++++----------------------- 1 file changed, 15 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 4078dde..e7b2aee 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,12 @@ # Floyd Engine -> **Dev Preview** - APIs may change. Not recommended for production use yet. +Open-source booking engine for AI agents. Two-phase booking, conflict detection, and scheduling policies — built for concurrent workloads. -Booking engine for AI agents. - -- **Services & Policies** - Define bookable offerings with scheduling rules -- **Hold → Confirm** - Two-phase booking for async workflows -- **Race-safe** - Database-level conflict detection -- **Retry-friendly** - Idempotent operations with automatic deduplication -- **Real-time** - Webhooks for booking events - -## Why Floyd? - -Building booking into AI agents is harder than it looks: - -- **Async conversations** - Users say "yes" seconds after you check availability -- **Retries & timeouts** - Network failures cause duplicate bookings -- **Concurrency** - Multiple agents booking the same resource - -Floyd handles all of this so you can focus on your agent. +- **Hold → Confirm** - Reserve a slot with TTL, confirm when ready, auto-expire if not +- **Conflict detection** - Database-level row locking + GiST indexes prevent double-booking +- **Scheduling policies** - Working hours, buffers, lead times, grid alignment +- **Idempotency** - Safe retries via `Idempotency-Key` header +- **Webhooks** - HMAC-signed booking events via transactional outbox ## Example @@ -37,8 +25,8 @@ curl -X POST http://localhost:4000/v1/ledgers/$LEDGER_ID/bookings \ -d '{ "serviceId": "svc_...", "resourceId": "rsc_stylist1", - "startAt": "2026-01-15T10:00:00Z", - "endAt": "2026-01-15T11:00:00Z" + "startTime": "2026-03-15T10:00:00Z", + "endTime": "2026-03-15T11:00:00Z" }' # 3. Confirm when user says "yes" @@ -59,15 +47,19 @@ docker run \ ghcr.io/floyd-run/engine:master ``` -See the [Quickstart guide](https://docs.floyd.run/docs/quickstart) for Docker Compose setup and full instructions. +See the [Quickstart guide](docs/quickstart.md) for Docker Compose setup and full instructions. ## Documentation -Full API reference, guides, and examples at [docs.floyd.run](https://docs.floyd.run) +Full API reference, guides, and examples in the [docs](docs/) folder. + +## Managed Cloud + +Prefer not to self-host? [floyd.run](https://floyd.run) is a hosted version with organizations, API keys, and a web console. ## Feedback -This is a dev preview - we'd love your input! Open an issue on [GitHub](https://github.com/floyd-run/engine/issues) or reach out at [hey@floyd.run](mailto:hey@floyd.run). +Open an issue on [GitHub](https://github.com/floyd-run/engine/issues) or reach out at [hey@floyd.run](mailto:hey@floyd.run). ## License