Add server help text. v0.3.1

Author: mTsBucy1

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "rusty-runner-server"
-version = "0.3.0"
+version = "0.3.1"
 edition = "2021"
 
 [lints]

rusty-runner-server/Cargo.toml

@@ -1,6 +1,6 @@
 //! Runs a server complying with the [`rusty_runner_api`].
 //!
-//! Listens on `localhost:8000` unless changed by the [`CliArgs`].
+//! Listens on `http://localhost:8000`, e.g. `http://localhost:8000/api/info` unless changed by the [`CliArgs`].
 //! The working directory is determined by [`{std::env::temp_dir()}/rusty-runner`][process::working_directory].
 
 use axum::routing::get;
@@ -53,6 +53,10 @@ async fn main() -> std::io::Result<()> {
         .await
 }
 
+/// Runs a server complying with the `rusty_runner_api`.
+///
+/// By default listens on `http://localhost:8000`, e.g. `http://localhost:8000/api/info` unless changed by the command line arguments.
+/// The working directory is determined by `{std::env::temp_dir()}/rusty-runner`.
 #[derive(Parser)]
 struct CliArgs {
     /// The host address for the rusty-runner server.

rusty-runner-server/src/main.rs

@@ -17,6 +17,7 @@ compile_error!("Unix and Windows are exclusive!");
 #[cfg(not(any(windows, unix)))]
 compile_error!("Either Unix or Windows must be targeted!");
 
+/// Routes under `/api`.
 pub fn routes() -> Router {
     Router::new()
         .route("/info", get(info))