Skip to content

Commit

Permalink
crux_core mod docs
Browse files Browse the repository at this point in the history
  • Loading branch information
StuartHarris committed Jan 30, 2025
1 parent ae41d96 commit 7fbf8d5
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions crux_core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
//! * Shell - the native side of the app on each platform handling UI and executing side effects
//!
//! * App - the main module of the core containing the application logic, especially model changes
//! and side-effects triggered by events. App can be composed from modules, each resembling a smaller, simpler app.
//! and side-effects triggered by events. An App can delegate to child apps, mapping Events and Effects.
//!
//! * Event - main input for the core, typically triggered by user interaction in the UI
//!
Expand All @@ -34,7 +34,11 @@
//! interaction with the host platform. Updating the UI is considered an effect.
//!
//! * Capability - A user-friendly API used to request effects and provide events that should be dispatched
//! when the effect is completed. For example, a HTTP client is a capability.
//! when an effect is completed. For example, a HTTP client is a capability.
//!
//! * Command - A description of a side-effect to be executed by the shell. Commands can be combined
//! (synchronously with combinators, or asynchronously with Rust async) to run
//! sequentially or concurrently, or any combination thereof.
//!
//! Below is a minimal example of a Crux-based application Core:
//!
Expand Down

0 comments on commit 7fbf8d5

Please sign in to comment.