Initial snapshot - OpenTelemetry demo 2.1.3 -f

1 files changed, 41 insertions, 0 deletions

diff --git a/src/product-catalog/README.md b/src/product-catalog/README.md
new file mode 100644
index 0000000..ca4970d
--- /dev/null
+++ b/src/product-catalog/README.md
@@ -0,0 +1,41 @@
+# Product Catalog Service
+
+When this service is run the output should be similar to the following
+
+```json
+{"message":"successfully parsed product catalog json","severity":"info","timestamp":"2022-06-02T23:54:10.191283363Z"}
+{"message":"starting grpc server at :3550","severity":"info","timestamp":"2022-06-02T23:54:10.191849078Z"}
+```
+
+## Local Build
+
+To build the service binary, run:
+
+```sh
+go build -o /go/bin/product-catalog/
+```
+
+## Docker Build
+
+From the root directory, run:
+
+```sh
+docker compose build product-catalog
+```
+
+## Regenerate protos
+
+To build the protos, run from the root directory:
+
+```sh
+make docker-generate-protobuf
+```
+
+## Bump dependencies
+
+To bump all dependencies run:
+
+```sh
+go get -u -t ./...
+go mod tidy
+```