Add crate docs for bins

nixpulvis · Sep 21, 2024 · 53c7fd7 · 53c7fd7
1 parent 4a9dd72
commit 53c7fd7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/galos_db/src/lib.rs b/galos_db/src/lib.rs
@@ -1,3 +1,8 @@
+//!  Database adapter and functions for `galos`
+//!
+//! Set `DATABASE_ENV` for configuring the connection. E.g:
+//! - `postgresql://localhost/galos_development`
+//! - `postgresql://postgres:"pw"@10.0.1.2/galos_production`
 use sqlx::postgres::{PgPool, PgPoolOptions};
 use std::env;
 

diff --git a/galos_map/src/lib.rs b/galos_map/src/lib.rs
@@ -1,3 +1,6 @@
+//! A 3D Galaxy Map for `galos`
+//!
+//! Requires (read-only) access to [`galos_db`].
 use bevy::prelude::*;
 use galos_db::Database;