From 75c418d3fb292a254f99a9ad79452c8d48ffb5b7 Mon Sep 17 00:00:00 2001 From: Mrucznik Date: Tue, 1 Dec 2020 01:08:43 +0100 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index fc9b699..daac047 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # mruv-api-placeholder Implementation of MruV API server with placeholder data. + +## How to run? +- **With docker:** +``` docker-compose up ``` +- **With go** +``` go run main.go ``` + +## How to build? +Just simple type: +``` +go buid +``` +In project root directory. + +## Configuration +You can configure this app by environment variables: +- HOST - host on which you want to serve API +- GRPC_PORT - port on which you want to serve gRPC API +- HTTP_PORT - port on which you want to serve gRPC-gateway REST API translation