Docs(api): updated README and added more info on api

IBM · Sep 17, 2024 · 8400ee5 · 8400ee5
1 parent 1ca76d5
commit 8400ee5
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -66,6 +66,7 @@ Available Commands:
   dir         Analyze cryptographic assets in a directory
   help        Help about any command
   image       Analyze cryptographic assets in a container image
+  server      Start a server (port: 8080, see openapi.yaml)
 
 Flags:
   -b, --bom string        BOM file to be verified and enriched
@@ -113,7 +114,10 @@ Server: Docker Engine - Community
 
 ```shell
 docker build -t cbomkit-theia . 
+# CLI
 docker run cbomkit-theia [command] > enriched_CBOM.json
+# Server
+docker run -d -p 8080:8080 cbomkit-theia
 ```
 
 ### Compiled

diff --git a/cmd/server.go b/cmd/server.go
@@ -24,7 +24,7 @@ import (
 
 var serverCmd = &cobra.Command{
 	Use:   "server",
-	Short: "Start a server",
+	Short: "Start a server (port: 8080, see openapi.yaml)",
 	Run: func(cmd *cobra.Command, args []string) {
 		server.Serve()
 	},