add readme for svgbob_server

2 files changed, 16 insertions, 1 deletions

diff --git a/packages/svgbob_server/README.md b/packages/svgbob_server/README.md
new file mode 100644
index 0000000..e61a07c
--- /dev/null
+++ b/packages/svgbob_server/README.md
@@ -0,0 +1,14 @@
+# Svgbob server
+
+This is running svgbob as a rest api
+
+```sh
+cargo install svgbob_server
+PORT=3000 svgbob_server
+```
+
+Then you can use svgbob in port 3000 to convert text diagrams into svg
+
+```sh
+curl -X POST -F 'ascii=o------>' http://localhost:3000 > output.svg
+```
diff --git a/packages/svgbob_server/src/main.rs b/packages/svgbob_server/src/main.rs
index e0b8f2a..ba96f5c 100644
--- a/packages/svgbob_server/src/main.rs
+++ b/packages/svgbob_server/src/main.rs
@@ -4,6 +4,7 @@ use axum::{routing::get, Router};
 use std::net::SocketAddr;
 
 const VERSION: &str = env!("CARGO_PKG_VERSION");
+const PACKAGE_NAME: &str = env!("CARGO_PKG_NAME");
 const DEFAULT_PORT: u16 = 3000;
 
 async fn hello() -> String {
@@ -30,7 +31,7 @@ async fn main() {
     let app = Router::new().route("/", get(hello).post(text_to_svgbob));
 
     let socket: SocketAddr = ([0, 0, 0, 0], port).into();
-    println!("serving at: {}", socket);
+    println!("Running {}{} at: http://{}", PACKAGE_NAME, VERSION, socket);
     axum::Server::bind(&socket)
         .serve(app.into_make_service())
         .await