commit c8fdc709ee2991ee521b14260f7e9e028718c86d parent 6a4acf16074b3035d66590920c0e1ec9c8407399 Author: MTRNord <mtrnord1@gmail.com> Date: Sun, 17 Sep 2017 16:06:33 +0200 Add README Signed-off-by: MTRNord <mtrnord1@gmail.com> Diffstat:
| A | README.md | | | 22 | ++++++++++++++++++++++ |
1 file changed, 22 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,22 @@ +# Matrix Protobuf/gRPC Proxy + +This Repo contains a Protobuf and gRPC Proxy named MatrixProtoBuf for the [Matrix Protocol](https://matrix.org) together with example clients for both of them. +They are designed to be run localy on a client or on Servers as they take a HS address on every request. + +### Join the discussion + +Join the discussion about this and help making decisions in [#MatrixProtoBuf:matrix.org](https://matrix.to/#/#MatrixProtoBuf:matrix.org) + +## How to build this? + +1. Install GB from [getgb.io](getgb.io) +2. Run `gb vendor restore` +3. Run `gb build` + +## How and what to run? + +To run only the Proxy which provides the access to the gRPC Server and HTTP Protobuf Server just run the MatrixProtoBuf* file in `bin`. + +## Where is the Protobuf definition? + +the .proto file is in `src/github.com/Nordgedanken/MatrixProtoBuf/matrixProtos` named matrix.proto