Hello World SME Invoker Service

[nonrtric.git] / sample-services / hello-world-sme-invoker / README.md

diff --git a/sample-services/hello-world-sme-invoker/README.md b/sample-services/hello-world-sme-invoker/README.md
new file mode 100644 (file)
index 0000000..95822a7
--- /dev/null
+++ b/sample-services/hello-world-sme-invoker/README.md
@@ -0,0 +1,37 @@
+# Hello World Sme Invoker Service\r
+\r
+This repository contains a Spring Boot application serving few Hello World SME endpoints. \r
+The application can be built and run using the provided script - ``hello-world-sme-invoker-build-start.sh``.\r
+\r
+## Prerequisites\r
+\r
+- Docker installed on your machine.\r
+\r
+## Building and Running the Application\r
+Run the script:\r
+\r
+```bash\r
+  ./hello-world-sme-invoker-build-start.sh\r
+```\r
+\r
+The script will build a Docker image and run a container with the Hello World SME service. After the container starts,\r
+wait for a few seconds to ensure the Spring Boot application is fully initialized. Next, it will make an HTTP request to the\r
+Hello World SME endpoint and display the response:\r
+\r
+```bash\r
+  response=$(curl -s http://localhost:8080/helloworld/v1/sme)\r
+  echo "Response from the Hello World SME endpoint:"\r
+  echo "$response"\r
+```\r
+\r
+To stop and remove the Docker container:\r
+\r
+```bash\r
+  docker stop hello-world-sme-invoker\r
+  docker rm hello-world-sme-invoker\r
+```\r
+\r
+## Additional Information\r
+\r
+- The Hello World SME endpoint is available at http://localhost:8080/helloworld/v1/sme.\r
+\r