diff --git a/src/lib.rs b/src/lib.rs index 35571f42..571706d6 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,4 +1,47 @@ -//! # Select +//!
+//! +//! +//! +//!

SeaORM

+//! +//!

+//! 🐚 An async & dynamic ORM for Rust +//!

+//! +//! Built with 🔥 by 🌊🦀🐚 +//! +//!
+//! +//! # SeaORM +//! +//! Inspired by ActiveRecord, Eloquent and TypeORM, SeaORM aims to provide you an intuitive and ergonomic +//! API to make working with databases in Rust a first-class experience. +//! +//! ```ignore +//! This is an early WIP of SeaORM, and is not yet published. See [example](examples/sqlx-mysql/src) for demo usage. +//! ``` +//! +//! ## Features +//! +//! 1. Async +//! +//! Relying on SQLx, SeaORM is a new library with async support from day 1. +//! +//! 2. Dynamic +//! +//! Built upon SeaQuery, a dynamic query builder, SeaORM allows you to build complex queries without 'fighting the ORM'. +//! +//! 3. Testable +//! +//! Use mock connections to write unit tests for your logic. +//! +//! 4. API oriented +//! +//! Quickly build search models that help you join, filter, sort and paginate data in APIs. +//! +//! # A quick taste of SeaORM +//! +//! ## Select //! ``` //! # use sea_orm::{DbConn, entity::*, query::*, tests_cfg::*}; //! # async fn function(db: &DbConn) -> Result<(), QueryErr> { @@ -28,7 +71,7 @@ //! # Ok(()) //! # } //! ``` -//! # Insert +//! ## Insert //! ``` //! # use sea_orm::{DbConn, entity::*, query::*, tests_cfg::*}; //! # async fn function(db: &DbConn) -> Result<(), ExecErr> { @@ -68,7 +111,7 @@ //! # Ok(()) //! # } //! ``` -//! # Update +//! ## Update //! ``` //! # use sea_orm::{DbConn, entity::*, query::*, tests_cfg::*}; //! # @@ -98,7 +141,7 @@ //! # Ok(()) //! # } //! ``` -//! # Delete +//! ## Delete //! ``` //! # use sea_orm::{DbConn, entity::*, query::*, tests_cfg::*}; //! #