updating readme

tlm-solutions · Sep 9, 2022 · 5ec4332 · 5ec4332
1 parent 4d5cd1b
commit 5ec4332
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,15 @@
-# funnel
-Service which filters and sends out data to all listening clients
+# Funnel
+
+![built with nix](https://builtwithnix.org/badge.svg)
+
+Service which filters and sends out data to all listening clients over websockets. This service expects the data to be sent over grpc.
+
+## Configuration
+
+### Environment
+
+- **GRPC_PORT**: mendatory under which the grpc server runs
+- **WEBSOCKET_PORT**: mendatory under which port the websocket port runs
+
+
+
diff --git a/src/main.cpp b/src/main.cpp
@@ -8,7 +8,7 @@
 int main() {
     try {
         std::cout << "GRPC_PORT:" << std::getenv("GRPC_PORT") << std::endl;
-        std::cout << "GRPC_WEBSOCKET:" << std::getenv("WEBSOCKET_PORT") << std::endl;
+        std::cout << "WEBSOCKET_PORT:" << std::getenv("WEBSOCKET_PORT") << std::endl;
         unsigned short grpc_port = static_cast<unsigned short>(std::stoi(std::getenv("GRPC_PORT")));
         unsigned short websocket_port = static_cast<unsigned short>(std::stoi(std::getenv("WEBSOCKET_PORT")));