🚧 Retoques en documentación y código

extensions/pagetop-seaorm/src/lib.rs

@@ -1,17 +1,122 @@
+/*!
+<div align="center">
+
+<h1>PageTop SeaORM</h1>
+
+<p>Proporciona a <strong>PageTop</strong> acceso basado en <a href="https://www.sea-ql.org/SeaORM">SeaORM</a> a bases de datos relacionales.</p>
+
+[![Doc API](https://img.shields.io/docsrs/pagetop-seaorm?label=Doc%20API&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-seaorm)
+[![Crates.io](https://img.shields.io/crates/v/pagetop-seaorm.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-seaorm)
+[![Descargas](https://img.shields.io/crates/d/pagetop-seaorm.svg?label=Descargas&style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-seaorm)
+[![Licencia](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?label=Licencia&style=for-the-badge)](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-seaorm#licencia)
+
+</div>
+
+## 🧭 Sobre PageTop
+
+[PageTop](https://docs.rs/pagetop) es un entorno de desarrollo que reivindica la esencia de la web
+clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y
+configurables, basadas en HTML, CSS y JavaScript.
+
+
+## ⚡️ Guía rápida
+
+**Añade la dependencia** a tu `Cargo.toml` activando el motor de base de datos que necesites:
+
+```toml
+[dependencies]
+pagetop-seaorm = { version = "...", features = ["sqlite"] }
+```
+
+Las *features* disponibles son `mysql`, `postgres` y `sqlite`.
+
+**Configura la conexión** en el archivo de configuración de la aplicación:
+
+```toml
+[database]
+db_type = "sqlite"
+db_name = "my_app.db"
+max_pool_size = 5
+```
+
+Para MySQL o PostgreSQL añade también `db_user`, `db_pass`, `db_host` y `db_port`.
+
+**Declara la extensión** en tu aplicación o en la extensión que la requiera:
+
+```rust,no_run
 use pagetop::prelude::*;
 
+struct MyApp;
+
+impl Extension for MyApp {
+    fn dependencies(&self) -> Vec<ExtensionRef> {
+        vec![
+            &pagetop_seaorm::SeaORM,
+        ]
+    }
+
+    fn initialize(&self) {
+        install_migrations!(m20240101_000001_create_users_table);
+    }
+}
+
+#[pagetop::main]
+async fn main() -> std::io::Result<()> {
+    Application::prepare(&MyApp).run()?.await
+}
+```
+
+**Escribe las migraciones** usando la API de SeaORM:
+
+```rust,no_run
+use pagetop_seaorm::prelude::*;
+
+#[derive(DeriveMigrationName)]
+pub struct Migration;
+
+#[async_trait::async_trait]
+impl MigrationTrait for Migration {
+    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        manager
+            .create_table(
+                table_auto(Users::Table)
+                    .col(pk_auto(Users::Id))
+                    .col(string_uniq(Users::Email))
+                    .to_owned(),
+            )
+            .await
+    }
+}
+
+#[derive(DeriveIden)]
+enum Users {
+    Table,
+    Id,
+    Email,
+}
+```
+*/
+
+#![doc(
+    html_favicon_url = "https://git.cillero.es/manuelcillero/pagetop/raw/branch/main/static/favicon.ico"
+)]
+
+use pagetop::prelude::*;
+
+include_locales!(LOCALES_SEAORM);
+
 pub mod config;
+
 pub mod db;
 
-/// Preludio de la extensión.
+/// *Prelude* de la extensión.
 pub mod prelude {
+    pub use crate::config::*;
     pub use crate::db::*;
     pub use crate::install_migrations;
 }
 
-include_locales!(LOCALES_SEAORM);
-
-/// Extensión que integra SeaORM como framework de base de datos para aplicaciones PageTop.
+/// Implementa la extensión.
 pub struct SeaORM;
 
 impl Extension for SeaORM {