chore: prepare hotfix-status for release (#177)

* Prepare hotfix-status for publishing

* Make custom error only available for UI feature as it's only used there

* Revise changelog for hotfix-status

Author: davidsteiner

Cargo.lock

@@ -15,19 +15,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Other
 
-- Fix initial creation time setting in redb store
-- Add check for code formatting
-- Add code coverage badge
-- Update version to 0.0.21 to release DynamoDB stores
-- Prepare for 0.0.19 release
-- Update README with Test Requests
-- Update README with next steps
-- Process backlog of messages when a resend is completed
-- Update README
-- Nicer API for manipulating groups and example application using repeating groups
-- Add badges
-- Update crates in preparation for 0.0.11 release
-- Switch to internal fork of ferrumfix for message encoding and decoding
-- Use fix44 types for message generation
-- Prepare project for crates.io publishing
-- Initial commit
+- initial release

crates/hotfix-status/CHANGELOG.md

@@ -1,11 +1,11 @@
 [package]
 name = "hotfix-status"
 description = "Status endpoints and an option web-based dashboard for the HotFIX engine"
-version.workspace = true
+version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true
-readme.workspace = true
+readme = "README.md"
 homepage.workspace = true
 repository.workspace = true
 keywords.workspace = true

crates/hotfix-status/Cargo.toml

@@ -0,0 +1,39 @@
+<div align="center">
+
+# hotfix-status
+
+**Status APIs and UI for the HotFIX engine.**
+
+</div>
+
+This crate is an add-on for the [HotFIX engine](https://github.com/Validus-Risk-Management/hotfix)
+to provide useful APIs about the FIX session state and health.
+
+Optionally, it also provides a web-based UI to view and manage the session state.
+
+## Usage
+
+`hotfix-status` build an `axum` router you can embed in your application in any way you like.
+
+To build the router, just call `build_router` with the HotFIX session ref:
+
+```rust
+...
+
+use hotfix_status::build_router;
+
+...
+
+async fn start_status_service(session_ref: SessionRef<Message>) {
+    let status_router = build_router(session_ref);
+    let host_and_port = std::env::var("HOST_AND_PORT").unwrap_or("0.0.0.0:9881".to_string());
+    let listener = tokio::net::TcpListener::bind(&host_and_port).await.unwrap();
+
+    info!("starting status service on http://{host_and_port}");
+    axum::serve(listener, status_router).await.unwrap();
+}
+```
+
+For a full example, check out
+the [simple-new-order](https://github.com/Validus-Risk-Management/hotfix/tree/main/examples/simple-new-order)
+sample application.

crates/hotfix-status/README.md

@@ -1,5 +1,6 @@
 mod api;
 mod data_provider;
+#[cfg(feature = "ui")]
 mod error;
 #[cfg(feature = "ui")]
 mod ui;
@@ -29,5 +30,7 @@ pub fn build_router<M: FixMessage>(session_ref: SessionRef<M>) -> Router {
 pub fn build_router<M: FixMessage>(session_ref: SessionRef<M>) -> Router {
     let data_provider = SessionDataProvider { session_ref };
     let state = AppState { data_provider };
-    Router::new().nest("/api", build_api_router(state))
+    Router::new()
+        .nest("/api", build_api_router())
+        .with_state(state)
 }