From 163412d693514433fc5a83e0c6be561f8599bfd5 Mon Sep 17 00:00:00 2001 From: intelligide Date: Sun, 22 Mar 2020 22:58:47 -0400 Subject: [PATCH] add README --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..795f2c9 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# OpenMatch C# API + +[![Nuget](https://img.shields.io/nuget/dt/OpenMatch.Api)](https://www.nuget.org/packages/OpenMatch.Api/) [![Azure Pipelines](https://img.shields.io/azure-devops/build/arsenstudio/4f5c7cb3-18f7-4b44-ab1e-c9a6a6e38873/5)](https://arsenstudio.visualstudio.com/OpenMatch%20CSharp/) + + +# Usage + +```sh +dotnet add package OpenMatch.Api +``` + +## Getting started + +### Client + +```c# +// Create the grpc. +using var channel = GrpcChannel.ForAddress("https://localhost:5001"); + +var frontendClient = new OpenMatch.FrontendService.FrontendServiceClient(channel); + +await frontendClient.CreateTicketAsync(request); +``` + +There is others services: +- `OpenMatch.FrontendService.FrontendServiceClient` +- `OpenMatch.BackendService.BackendServiceClient` +- `OpenMatch.EvaluatorService.EvaluatorServiceClient` +- `OpenMatch.MatchFunction.MatchFunctionServiceClient` +- `OpenMatch.QueryService.QueryServiceClient` + + +See [Open Match API References](https://open-match.dev/site/docs/reference/api/) for more informations. + + +## Contributing + +Please see [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.