summaryrefslogtreecommitdiff
path: root/src/currency/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/currency/README.md')
-rw-r--r--src/currency/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/currency/README.md b/src/currency/README.md
new file mode 100644
index 0000000..e1c5079
--- /dev/null
+++ b/src/currency/README.md
@@ -0,0 +1,32 @@
+# Currency Service
+
+The Currency Service does the conversion from one currency to another.
+It is a C++ based service.
+
+## Building docker image
+
+To build the currency service, run the following from root directory
+of opentelemetry-demo
+
+```sh
+docker compose build currency
+```
+
+## Run the service
+
+Execute the below command to run the service.
+
+```sh
+docker compose up currency
+```
+
+## Run the client
+
+currencyclient is a sample client which sends some request to currency
+service. To run the client, execute the below command.
+
+```sh
+docker exec -it <container_name> currencyclient 7000
+```
+
+`7000` is port where currency listens to.