Readme

SeaQL · Sep 30, 2021 · 17eea95 · 17eea95
1 parent 013b145
commit 17eea95
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ We provide integration for [SQLx](https://crates.io/crates/sqlx),
 [postgres](https://crates.io/crates/postgres) and [rusqlite](https://crates.io/crates/rusqlite).
 See [examples](https://github.com/SeaQL/sea-query/blob/master/examples) for usage.
 
-This library is the foundation of [SeaORM](https://github.com/SeaQL/sea-orm), an async & dynamic ORM for Rust.
+SeaQuery is the foundation of [SeaORM](https://github.com/SeaQL/sea-orm), an async & dynamic ORM for Rust.
 
 ## Install
 
@@ -36,6 +36,19 @@ This library is the foundation of [SeaORM](https://github.com/SeaQL/sea-orm), an
 sea-query = "^0"
 ```
 
+SeaQuery is very lightweight, all dependencies are optional.
+
+### Feature flags
+
+SQL dialect: `backend-mysql`, `backend-postgres`, `backend-sqlite`
+
+Type support: `with-chrono`, `with-json`, `with-rust_decimal`, `with-bigdecimal`, `with-uuid`
+
+Async support: `thread-safe` (use `Arc` inplace of `Rc`)
+
+Driver support: `sqlx-mysql`, `sqlx-postgres`, `sqlx-sqlite`,
+`postgres`, `postgres-*`, `rusqlite`
+
 ## Usage
 
 Table of Content

diff --git a/src/lib.rs b/src/lib.rs
@@ -29,7 +29,7 @@
 //! [postgres](https://crates.io/crates/postgres) and [rusqlite](https://crates.io/crates/rusqlite).
 //! See [examples](https://github.com/SeaQL/sea-query/blob/master/examples) for usage.
 //!
-//! This library is the foundation of [SeaORM](https://github.com/SeaQL/sea-orm), an async & dynamic ORM for Rust.
+//! SeaQuery is the foundation of [SeaORM](https://github.com/SeaQL/sea-orm), an async & dynamic ORM for Rust.
 //!
 //! ## Install
 //!
@@ -39,6 +39,19 @@
 //! sea-query = "^0"
 //! ```
 //!
+//! SeaQuery is very lightweight, all dependencies are optional.
+//!
+//! ### Feature flags
+//!
+//! SQL dialect: `backend-mysql`, `backend-postgres`, `backend-sqlite`
+//!
+//! Type support: `with-chrono`, `with-json`, `with-rust_decimal`, `with-bigdecimal`, `with-uuid`
+//!
+//! Async support: `thread-safe` (use `Arc` inplace of `Rc`)
+//!
+//! Driver support: `sqlx-mysql`, `sqlx-postgres`, `sqlx-sqlite`,
+//! `postgres`, `postgres-*`, `rusqlite`
+//!
 //! ## Usage
 //!
 //! Table of Content