Skip to content

Commit

Permalink
Top level crate documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
horned-sphere committed Jun 21, 2024
1 parent 4a4ad2a commit 07707e0
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions swimos/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! # SwimOS
//! A framework for building real-time streaming applications that model the state of an external system.
//! The state of a SwimOS application is split across a number of "agents", identified by URI. Agents
//! consists of some number of named "lanes", each of which is individually addressable. An external client
//! of the application can modify the value of lanes, to update the model, and subscribe the changes to the
//! state of those lanes. State updates are pushed to the clients so it is not necessary to poll for changes.
//!
//! ## Feature Flags
//! This crate has a number of feature flags, none of which are enabled by default:
//!
//! 1. `agent` - The API for defining your own agents.
//! 2. `server` - The SwimOS server, necessary for running a SwimOS application.
//! 3. `json` - Enables JSON serialization support for HTTP lanes.
#[doc(inline)]
pub use swimos_model as model;

Expand Down

0 comments on commit 07707e0

Please sign in to comment.