diff --git a/README.md b/README.md index 827158adf3e..159d8fc39a4 100644 --- a/README.md +++ b/README.md @@ -26,20 +26,21 @@ runtime comes as a package available in a user's language package manager. For instructions on how to use the language-specific gRPC runtime for a project, please refer to these documents -- [C++](src/cpp): follow the instructions under the `src/cpp` directory -- [C#/.NET](https://github.com/grpc/grpc-dotnet): NuGet packages `Grpc.Net.Client`, `Grpc.AspNetCore.Server` -- [Dart](https://github.com/grpc/grpc-dart): pub package `grpc` -- [Go](https://github.com/grpc/grpc-go): `go get google.golang.org/grpc` -- [Java](https://github.com/grpc/grpc-java): Use JARs from Maven Central - Repository -- [Kotlin](https://github.com/grpc/grpc-kotlin): Use JARs from Maven Central - Repository -- [Node](https://github.com/grpc/grpc-node): `npm install @grpc/grpc-js` -- [Objective-C](src/objective-c): Add `gRPC-ProtoRPC` dependency to podspec -- [PHP](src/php): `pecl install grpc` -- [Python](src/python/grpcio): `pip install grpcio` -- [Ruby](src/ruby): `gem install grpc` -- [WebJS](https://github.com/grpc/grpc-web): follow the grpc-web instructions +- [C++](src/cpp): follow the instructions under the `src/cpp` directory +- [C#/.NET](https://github.com/grpc/grpc-dotnet): NuGet packages + `Grpc.Net.Client`, `Grpc.AspNetCore.Server` +- [Dart](https://github.com/grpc/grpc-dart): pub package `grpc` +- [Go](https://github.com/grpc/grpc-go): `go get google.golang.org/grpc` +- [Java](https://github.com/grpc/grpc-java): Use JARs from Maven Central + Repository +- [Kotlin](https://github.com/grpc/grpc-kotlin): Use JARs from Maven Central + Repository +- [Node](https://github.com/grpc/grpc-node): `npm install @grpc/grpc-js` +- [Objective-C](src/objective-c): Add `gRPC-ProtoRPC` dependency to podspec +- [PHP](src/php): `pecl install grpc` +- [Python](src/python/grpcio): `pip install grpcio` +- [Ruby](src/ruby): `gem install grpc` +- [WebJS](https://github.com/grpc/grpc-web): follow the grpc-web instructions Per-language quickstart guides and tutorials can be found in the [documentation section on the grpc.io website](https://grpc.io/docs/). Code @@ -66,8 +67,7 @@ gRPC. ## Performance -See the -[Performance dashboard](https://grafana-dot-grpc-testing.appspot.com/) +See the [Performance dashboard](https://grafana-dot-grpc-testing.appspot.com/) for performance numbers of master branch daily builds. ## Concepts @@ -77,28 +77,28 @@ See [gRPC Concepts](CONCEPTS.md) ## About This Repository This repository contains source code for gRPC libraries implemented in multiple -languages written on top of a shared C core library [src/core](src/core). +languages written on top of a shared C++ core library [src/core](src/core). Libraries in different languages may be in various states of development. We are seeking contributions for all of these libraries: -| Language | Source | -| ----------------------- | ---------------------------------- | -| Shared C [core library] | [src/core](src/core) | -| C++ | [src/cpp](src/cpp) | -| Ruby | [src/ruby](src/ruby) | -| Python | [src/python](src/python) | -| PHP | [src/php](src/php) | -| C# (core library based) | [src/csharp](src/csharp) | -| Objective-C | [src/objective-c](src/objective-c) | - -| Language | Source repo | -| -------------------- | -------------------------------------------------- | -| Java | [grpc-java](https://github.com/grpc/grpc-java) | -| Kotlin | [grpc-kotlin](https://github.com/grpc/grpc-kotlin) | -| Go | [grpc-go](https://github.com/grpc/grpc-go) | -| NodeJS | [grpc-node](https://github.com/grpc/grpc-node) | -| WebJS | [grpc-web](https://github.com/grpc/grpc-web) | -| Dart | [grpc-dart](https://github.com/grpc/grpc-dart) | -| .NET (pure C# impl.) | [grpc-dotnet](https://github.com/grpc/grpc-dotnet) | -| Swift | [grpc-swift](https://github.com/grpc/grpc-swift) | +Language | Source +------------------------- | ---------------------------------- +Shared C++ [core library] | [src/core](src/core) +C++ | [src/cpp](src/cpp) +Ruby | [src/ruby](src/ruby) +Python | [src/python](src/python) +PHP | [src/php](src/php) +C# (core library based) | [src/csharp](src/csharp) +Objective-C | [src/objective-c](src/objective-c) + +Language | Source repo +-------------------- | -------------------------------------------------- +Java | [grpc-java](https://github.com/grpc/grpc-java) +Kotlin | [grpc-kotlin](https://github.com/grpc/grpc-kotlin) +Go | [grpc-go](https://github.com/grpc/grpc-go) +NodeJS | [grpc-node](https://github.com/grpc/grpc-node) +WebJS | [grpc-web](https://github.com/grpc/grpc-web) +Dart | [grpc-dart](https://github.com/grpc/grpc-dart) +.NET (pure C# impl.) | [grpc-dotnet](https://github.com/grpc/grpc-dotnet) +Swift | [grpc-swift](https://github.com/grpc/grpc-swift)