diff --git a/signal/README.md b/signal/README.md index 53421397b..277882d5b 100644 --- a/signal/README.md +++ b/signal/README.md @@ -1,18 +1,23 @@ +# Wiretrustee Signal Server + This is a Wiretrustee signal-exchange server and client library to exchange connection information between Wiretrustee Trusted Device and Wiretrustee Hub The project uses gRPC library and defines service in protobuf file located in: ```proto/signal_exchange.proto``` - + To build the project you have to do the following things. Install protobuf version 3 (by default v3 is installed on ubuntu 20.04. On previous versions it is proto 2): - ``` + +```bash +#!/bin/bash sudo apt install protoc-gen-go sudo apt install golang-goprotobuf-dev - ``` - -Generate gRPC code: - ``` - protoc -I proto/ proto/signalexchange.proto --go_out=plugins=grpc:proto +``` - ``` \ No newline at end of file +Generate gRPC code: + +```bash +#!/bin/bash +protoc -I proto/ proto/signalexchange.proto --go_out=plugins=grpc:proto +```