diff --git a/README.md b/README.md index daa9cd0..9a5f5b9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ ![bknd](https://raw.githubusercontent.com/bknd-io/bknd/refs/heads/main/app/src/ui/assets/poster.png) -bknd simplifies backend development by providing powerful tools for data management, workflows, authentication, and media handlingโ€”all seamlessly integrated into a developer-friendly platform. +bknd simplifies app development by providing fully functional backend for data management, +authentication, workflows and media. Since it's lightweight and built on Web Standards, it can +be deployed nearly anywhere, including running inside your framework of choice. No more +deploying multiple separate services! **For documentation and examples, please visit https://docs.bknd.io.** @@ -8,35 +11,27 @@ bknd simplifies backend development by providing powerful tools for data managem > Please keep in mind that **bknd** is still under active development > and therefore full backward compatibility is not guaranteed before reaching v1.0.0. - -## Why bknd? -**Developer-Centric**: Focus on building your appโ€”bknd handles the heavy lifting. -**Scalable**: Designed to run in any JavaScript environment (cloud or edge) -databases. -**Integrated**: Everything from data to workflows, auth, and media, in one cohesive platform. - - ## โœจ Features -- **๐Ÿ“Š Data**: Define, query, and control your data with ease. - - Define entities with fields and relationships, synced directly to your database. +**๐Ÿ“Š Data**: Define, query, and control your data with ease. +- Define entities with fields and relationships, synced directly to your database. - Supported field types: `primary`, `text`, `number`, `date`, `boolean`, `enum`, `json`, `jsonschema`. - Relationship types: `one-to-one`, `many-to-one`, `many-to-many`, and `polymorphic`. - Advanced querying with the **Repository**: filtering, sorting, pagination, and relational data handling. - Seamlessly manage data with mutators and a robust event system. - Extend database functionality with batching, introspection, and support for multiple SQL dialects. -- **๐Ÿ” Auth**: Easily implement reliable authentication strategies. +**๐Ÿ” Auth**: Easily implement reliable authentication strategies. - Built-in `user` entity with customizable fields. - Supports multiple authentication strategies: - Email/password (with hashed storage). - OAuth/OIDC (Google, GitHub, and more). - Secure JWT generation and session management. -- **๐Ÿ–ผ๏ธ Media**: Effortlessly manage and serve all your media files. +**๐Ÿ–ผ๏ธ Media**: Effortlessly manage and serve all your media files. - Upload files with ease. - Adapter-based support for S3, S3-compatible storage (e.g., R2, Tigris), and Cloudinary. -- **๐Ÿ”„ Flows**: Design and run workflows with seamless automation. +**๐Ÿ”„ Flows** (UI integration coming soon!): Design and run workflows with seamless automation. - Create and run workflows with trigger-based automation: - Manual triggers or events from data, auth, media, or server actions. - HTTP triggers for external integrations.